Sign in

v1

latestOpenAPI 3.0.22026-07-146168117.0 KB
Webhooks

This endpoint creates a specific webhook on a form. Please note that this feature is exclusively available as part of the Business API.

post/forms/{slug_or_id}/webhooks

Path parameters

slug_or_idstring required

The form's slug, custom slug or ID.

Request body

idstring uuid

The id of the webhook.

target_urlstring url

The url for the webhook.

triggersstring[]

The triggers for the webhook.

created_atstring date-time

A formatted date-time string in your account timezone indicating the time the webhook was created.

updated_atstring date-time

A formatted date-time string in your account timezone indicating the time the webhook was last updated.

account_timezonestring

The timezone of your account.

created_at_utcstring date-time

A formatted date-time string in UTC timezone indicating the time the webhook was created.

updated_at_utcstring date-time

A formatted date-time string in UTC timezone indicating the time the webhook was last updated.

Example request

{
  "target_url": "https://example.com/webhook",
  "triggers": [
    "submission"
  ],
  "created_at": "2018-01-01T12:00:00Z",
  "updated_at": "2018-01-01T12:00:00Z",
  "account_timezone": "America/Los_Angeles",
  "created_at_utc": "2018-01-01T12:00:00Z",
  "updated_at_utc": "2018-01-01T12:00:00Z"
}

Response

Successfully created a single webhook with the provided values

status'ok'

Example response

{
  "results": {
    "webhook": {
      "target_url": "https://example.com/webhook",
      "triggers": [
        "submission"
      ],
      "created_at": "2018-01-01T12:00:00Z",
      "updated_at": "2018-01-01T12:00:00Z",
      "account_timezone": "America/Los_Angeles",
      "created_at_utc": "2018-01-01T12:00:00Z",
      "updated_at_utc": "2018-01-01T12:00:00Z"
    }
  }
}