Objects

WebhookCreate

Fields

• urlstringrequired

  Receiver URL, https:// only, up to 2048 characters.

  length ≤ 2048

• descriptionstring

  length ≤ 200

• eventsarray of WebhookEventFilterrequired

  items ≥ 1

• roleWebhookRole
• data_profile_idinteger | null
• collection_idsarray of integer

  Collections the webhook receives events about. No value or an empty list means all collections available to the role and the data profile. A key that is itself restricted to collections creates a webhook only with a non-empty list of its own collections. Without this field, with an empty list or with a collection outside its list, the request returns 403 webhooks.collections_outside_key.

  items ≤ 200

• tagsarray of string

  items ≤ 50

• payloadWebhookPayloadMode
• headersarray of WebhookHeaderInput

  items ≤ 10

• authWebhookAuthInput

Used by

• POST/v1/webhooksCreate a webhook