v1
latestOpenAPI 3.0.22026-07-146168117.0 KBWebhooks
This endpoint returns a list of webhooks for a form that are accessible by the authorized user. Please note that this feature is exclusively available as part of the Business API.
get/forms/{slug_or_id}/webhooks
Path parameters
slug_or_idstring required
The form's slug, custom slug or ID.
Query parameters
limitinteger
The number or results to return.
skipinteger
Number of results to skip in the result set.
after_idstring
Return results after the provided ID.
before_idstring
Return results before the provided ID.
before_datestring date-time
Return results created on or after this date-time (UTC). Overwritten by before_id.
after_datestring date-time
Return results created before this date (UTC). Overwritten by after_id.
sort'ASC' | 'DESC'
The direction to sort in. Results are sorted by created_at, and defaults to "DESC".
Response
Successfully returned a list of webhooks for a form
Example response
{
"results": {
"webhooks": [
{
"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"
}
]
},
"total": 57,
"has_more": true,
"limit": 20
}