Sign in
Webhook

Create a webhook

Creates a webhook.

post/webhook

Headers

Accept'application/vnd.Creative Force.v2.3+json' | 'application/vnd.Creative Force.v2.3+xml' required

Defines the response type.

Request body

method'get' | 'post' required

HTTP method used to call the webhook URL.

namestring required

Name of the webhook.

urlstring uri required

URL that receives the webhook payload.

signing_keystring

Key used to sign outgoing webhook requests so the receiver can validate the payload.

eventsstring[] required

Subscription events that trigger this webhook. For example, ["role_granted", "allocation_created"].

Response

Webhook created.

eventsstring[]

Subscription events that trigger this webhook.

method'get' | 'post'

HTTP method used to call the webhook URL.

namestring

Name of the webhook.

slugstring

Slug of the webhook.

signing_keystring

Key used to sign outgoing webhook requests so the receiver can validate the payload.

urlstring uri

URL that receives the webhook payload.

updatedstring date-time

Date and time the webhook was last updated.

Changes