Profile

Create a new webhook profile

post/notifications/webhooks

Request

Request body

eventTypesstring[]

Event types that will be sent to the URL. If empty, then all events will be sent to the URL.

Reference Webhook events

eventVersionstring

Version of webhooks sent to the URL. If not specified, the current date will be used.

Reference Webhook version

namestring required

Display name

urlstring required

URL where webhooks will be sent

Response

Webhook profile created

accountIdstring

Account Id

eventTypesstring[]

Event types that will be sent to the URL. If empty, then all events will be sent to the URL.

Reference Webhook events

eventVersionstring

Version of webhooks sent to the URL.

Reference Webhook version

idstring

Unique identifier

keystring

Unique key corresponding to a webhook profile's position in a paginated list of results. Only present if this webhook profile is in a paginated response.

Reference Pagination

namestring

Display name

secretstring

Secret used to validate authenticity of a webhook.

Reference Webhook authentication

status'ACTIVE' | 'DISABLED'

Current status

urlstring

URL where webhooks will be sent

Changes

No recorded changes to this operation across all 1 revision of this API.