Sign in

v50

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

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.

x-api-languagestring[]

Defines the languages included in the response. If non are provided, the account default language is returned.

Value all overrides any other values present.

You can request multiple languages using a comma-separated string of languages.

The selected language must be supported by your account or a 400 error is returned.

Request body

method'get' | 'post'

HTTP method used to call the webhook URL.

Values are case-sensitive.

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. Must be alphanumeric (A–Z, a–z, 0–9).

Omit to keep the existing key. When supplied, it replaces the current key.

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[]

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

Response

Webhook updated.

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"
}