Create a webhook
Creates a webhook.
- allocation_created
- allocation_payment_created
- allocation_payment_deleted
- allocation_payment_status_changed
- allocation_payment_updated
- application_category_changed
- application_chapter_changed
- application_copied
- application_created
- application_deleted
- application_eligible
- application_ineligible
- application_moderated
- application_resubmitted
- application_submitted
- application_tagged
- application_updated
- assignment_completed
- assignment_created
- collaborator_invited
- document_created
- document_deleted
- document_updated
- field_value_updated
- grant_report_created
- grant_report_submitted
- grant_status_changed
- membership_registered (user created)
- order_payment_pending
- order_payment_success
- review_task_created
- review_task_submitted
- role_granted
- user_updated
Authorizations
API key used to authenticate and authorise every request.
Include it in the x-api-key header.
Headers
Defines the response type.
application/vnd.Creative Force.v2.3+json, application/vnd.Creative Force.v2.3+xml Body
Webhook create payload.
HTTP method used to call the webhook URL.
Values are case-sensitive.
get, post Name of the webhook.
URL that receives the webhook payload.
Subscription events that trigger this webhook. For example, ["application_created", "application_submitted"].
1allocation_created, allocation_payment_created, allocation_payment_deleted, allocation_payment_status_changed, allocation_payment_updated, application_category_changed, application_chapter_changed, application_copied, application_created, application_deleted, application_eligible, application_ineligible, application_moderated, application_resubmitted, application_submitted, application_tagged, application_updated, assignment_completed, assignment_created, collaborator_invited, document_created, document_deleted, document_updated, field_value_updated, grant_report_created, grant_report_submitted, grant_status_changed, membership_registered, order_payment_pending, order_payment_success, review_task_created, review_task_submitted, role_granted, user_updated Key used to sign outgoing webhook requests so the receiver can validate the payload. Must be alphanumeric (A–Z, a–z, 0–9).
If omitted, the account's existing webhook signing key is reused, or a new key is generated when the account has none. Supply a unique key to isolate each receiver's trust boundary.
128^[A-Za-z0-9]+$Email addresses that receive webhook delivery-failure notifications. Accepts a single address or multiple comma-separated addresses as a string.
Slug of the form to scope the webhook to. When set, the webhook only fires for events on that form. Omit or set to null for an account-wide webhook.
Constraint: only accepted when field_value_updated is among the events array. Sending form without field_value_updated in the events list returns a 422 validation error.
^[A-Za-z]{8}$Slugs of the fields to include in the webhook payload.
^[A-Za-z]{8}$Response
Webhook created.
Subscription events that trigger this webhook.
Fields included in the webhook payload.
Form the webhook is scoped to. null when the webhook is not scoped to a specific form. When populated, returns slug, link, and name.
HTTP method used to call the webhook URL.
get, post Name of the webhook.
Slug of the webhook.
Key used to sign outgoing webhook requests so the receiver can validate the payload.
URL that receives the webhook payload.
Date and time the webhook was created.
Date and time the webhook was last updated.