Webhook

A configurable notification that submits external JSON-API-formatted HTTP requests whenever resources are modified.

action
string or null <= 255 characters

The action that will trigger this webhook (e.g. "*", "created", "updated", "destroyed"). Webhooks will only execute if both the action and resource match.

active
boolean or null

A boolean value indicating whether the webhook is active.

createdAt
string or null <date-time>

The date and time the webhook was created.

disabledReason
string or null <= 1024 characters

The reason why webhook got temporarily disabled. Any update to a webhook resets this to a null value.

disabledSince
string or null <date-time>

The date and time when the webhook got temporarily disabled for the first time. Any update to a webhook resets this to a null value.

disabledUntil
string or null <date-time>

The date and time till when the webhook got temporarily disabled. Any update to a webhook resets this to a null value.

payloadVersion
integer or null

Format of the body data sent when the webhook makes a request. Valid values are 1 or 2.

resource
string or null <= 255 characters

The resource that will trigger this webhook (e.g. "*", "prospect", "sequenceState"). Webhooks will only execute if both the action and resource match.

secret
string or null <= 255 characters

A private token used to verify the authenticity of incoming webhook payloads.

updatedAt
string or null <date-time>

The date and time the webhook was last updated.

url
string or null <= 1024 characters

The URL where the webhook will route its POST HTTP request.

{
  • "action": "string",
  • "active": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "disabledReason": "string",
  • "disabledSince": "2019-08-24T14:15:22Z",
  • "disabledUntil": "2019-08-24T14:15:22Z",
  • "payloadVersion": 0,
  • "resource": "string",
  • "secret": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "url": "string"
}

Webhook Relationships

object

The authorizer of the webhook. The webhook will not deliver results if the authorizer does not have permission to read the resource being returned. Relationship authorizer cannot be used as a filter.

object

The creator of the webhook. You can use only the attribute id to filter webhooks by creator (e.g. filter[creator][id]=X).

object

The most recent updater of the webhook. You can use only the attribute id to filter webhooks by updater (e.g. filter[updater][id]=X).

{}

Webhook Resource Metadata

METADATA NAME DESCRIPTION QUERY PARAM
canWrite A boolean value indicating whether the current API user has write access to this resource. provideAuthorizationMeta
canDelete A boolean value indicating whether the current API user has delete access to this resource. provideAuthorizationMeta

⌵ Webhook Actions

Get a Collection of Webhooks

SecuritybearerAuth and s2sAuthToken
Responses
200

OK

422

JSON error message

get/webhooks
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": [
    ]
}
Create a New Webhook
SecuritybearerAuth and s2sAuthToken 
Request 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
201
Created


422
JSON error message


post/webhooks
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Delete an Existing Webhook by ID
SecuritybearerAuth and s2sAuthToken 
Request 
path Parameters
id
required
integer
 
Responses 
204
Deleted


422
JSON error message


delete/webhooks/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "errors": [
    ]
}
Get a Webhook by ID
SecuritybearerAuth and s2sAuthToken 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


404
Not Found


get/webhooks/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Update a Webhook
SecuritybearerAuth and s2sAuthToken 
Request 
path Parameters
id
required
integer
 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
200
OK


422
JSON error message


patch/webhooks/{id}
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}