curl --request POST \
--url https://api.us.cr4ce.com/webhook \
--header 'Accept: <accept>' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"method": "post",
"name": "Application submissions",
"url": "https://example.com/webhooks/applications",
"notification_emails": "alerts@example.com",
"form": "AbCdEfGh",
"fields": [
"IjKlMnOp"
],
"events": [
"application_submitted",
"field_value_updated"
]
}
'{
"created": "2025-12-21T23:11:20Z",
"events": [
"application_created",
"application_submitted"
],
"fields": [],
"form": null,
"method": "post",
"name": "Application notifications",
"signing_key": "REDACTED",
"slug": "AbCdEfGh",
"updated": "2025-12-21T23:11:20Z",
"url": "https://example.com/webhooks"
}{
"message": "<string>",
"status_code": 400
}{
"message": "<string>",
"status_code": 401
}{
"message": "<string>",
"status_code": 403
}{
"message": "<string>",
"status_code": 422,
"errors": {}
}{
"message": "<string>",
"status_code": 429
}{
"status": "Maintenance in progress"
}Create webhook
Create a webhook.
curl --request POST \
--url https://api.us.cr4ce.com/webhook \
--header 'Accept: <accept>' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"method": "post",
"name": "Application submissions",
"url": "https://example.com/webhooks/applications",
"notification_emails": "alerts@example.com",
"form": "AbCdEfGh",
"fields": [
"IjKlMnOp"
],
"events": [
"application_submitted",
"field_value_updated"
]
}
'{
"created": "2025-12-21T23:11:20Z",
"events": [
"application_created",
"application_submitted"
],
"fields": [],
"form": null,
"method": "post",
"name": "Application notifications",
"signing_key": "REDACTED",
"slug": "AbCdEfGh",
"updated": "2025-12-21T23:11:20Z",
"url": "https://example.com/webhooks"
}{
"message": "<string>",
"status_code": 400
}{
"message": "<string>",
"status_code": 401
}{
"message": "<string>",
"status_code": 403
}{
"message": "<string>",
"status_code": 422,
"errors": {}
}{
"message": "<string>",
"status_code": 429
}{
"status": "Maintenance in progress"
}- 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
Headers
Body
Webhook create 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]+$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}$Response
Webhook created.