Skip to main content
POST
/
api
/
v1
/
webhooks
CreateWebhook
curl --request POST \
  --url https://your-sift-api-url.com/api/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "targetUrl": "<string>",
  "eventType": "WEBHOOK_EVENT_TYPE_UNSPECIFIED",
  "httpHeaders": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "payload": "<string>"
}
'
{
  "webhook": {
    "webhookId": "<string>",
    "organizationId": "<string>",
    "targetUrl": "<string>",
    "name": "<string>",
    "eventType": "WEBHOOK_EVENT_TYPE_UNSPECIFIED",
    "createdDate": "2023-11-07T05:31:56Z",
    "modifiedDate": "2023-11-07T05:31:56Z",
    "createdByUserId": "<string>",
    "modifiedByUserId": "<string>",
    "httpHeaders": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ],
    "payload": "<string>",
    "archivedDate": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

The request for a call to WebhookService_CreateWebhook to create a webhook.

The request for a call to WebhookService_CreateWebhook to create a webhook.

​
name
string
required
​
targetUrl
string
required
​
eventType
enum<string>
default:WEBHOOK_EVENT_TYPE_UNSPECIFIED
required
Available options:
WEBHOOK_EVENT_TYPE_UNSPECIFIED,
WEBHOOK_EVENT_TYPE_RULE_VIOLATION
​
httpHeaders
object[]
required
​
payload
string

Response

A successful response.

The response of a call to WebhookService_CreateWebhook.

​
webhook
object
required