Webhook

Update a webhook

Updates the webhook identified by the specified slug.

put/webhook/{webhook_slug}

Path parameters

webhook_slugstring required

Slug of the 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'

HTTP method used to call the webhook URL.

namestring

Name of the webhook.

urlstring uri

URL that receives the webhook payload.

signing_keystring

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

eventsstring[]

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

Response

Webhook updated.

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