POST
/
webhook
/

The following endpoint is deprecated.

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Body

application/json

Request model for Webhook Definition

target
string
required

target url

protocol
string
required
source
string
required

Source of event triggers

events
string[]
required

List of events for which the webhook need to trigger the target

requestType
enum<string>
required

List of events for which the webhook need to trigger the target

Available options:
POST,
PUT,
PATCH,
GET,
DELETE
tenantId
string
targetApiKey
string

Api key of the target service , if authentication is required

apiVersion
string
deprecated
format
string

Content-Type of request body while triggering Webhook

callbackUrl
string
deprecated
createdDate
string
updatedDate
string

Response

200 - application/json

Request model for Updating Webhook Definition

target
string
required

target url

protocol
string
required
source
string
required

Source of event triggers

events
string[]
required

List of events for which the webhook need to trigger the target

requestType
enum<string>
required

List of events for which the webhook need to trigger the target

Available options:
POST,
PUT,
PATCH,
GET,
DELETE
webhookId
string
tenantId
string
targetApiKey
string

Api key of the target service , if authentication is required

apiVersion
string
deprecated
format
string

Content-Type of request body while triggering Webhook

callbackUrl
string
deprecated
createdDate
string
updatedDate
string

Was this page helpful?

Get all webhook definitionsGet webhook definition by ID