Sign in

v50

latestOpenAPI 3.1.0Creative Force Client Subscription Termsraw.githubusercontent.com2026-07-137852387.4 KB
Webhooks

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.

Values are case-sensitive.

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. 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.

formstring nullable

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.

fieldsstring[]

Slugs of the fields to include in the webhook payload.

eventsstring[] required

Subscription events that trigger this webhook. For example, ["entry_created", "entry_submitted"].

Response

Webhook created.

eventsstring[]

Subscription events that trigger this webhook.

formstring nullable

Slug of the form the webhook is scoped to. null when the webhook is not scoped to a specific form.

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.

createdstring date-time

Date and time the webhook was created.

updatedstring date-time

Date and time the webhook was last updated.

Example response

{
  "created": "2025-12-21T23:11:20Z",
  "events": [
    "entry_created",
    "entry_submitted"
  ],
  "fields": [],
  "form": null,
  "method": "post",
  "name": "Entry notifications",
  "signing_key": "REDACTED",
  "slug": "AbCdEfGh",
  "updated": "2025-12-21T23:11:20Z",
  "url": "https://example.com/webhooks"
}