Sift | Docs
APIReferenceREST (HTTP/JSON)Webhook service

CreateWebhook

Create a webhook.

POST
/api/v1/webhooks

Request Body

application/jsonRequired

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

name
Required
string

targetUrl
Required
string

eventType
Required
string

Default: "WEBHOOK_EVENT_TYPE_UNSPECIFIED"Value in: "WEBHOOK_EVENT_TYPE_UNSPECIFIED" | "WEBHOOK_EVENT_TYPE_RULE_VIOLATION"

payloadstring

httpHeaders
Required
array<object>

curl -X POST "<API_URL>/api/v1/webhooks" \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "targetUrl": "string",
    "eventType": "WEBHOOK_EVENT_TYPE_UNSPECIFIED",
    "payload": "string",
    "httpHeaders": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  }'

A successful response.

{
  "webhook": {
    "webhookId": "string",
    "organizationId": "string",
    "targetUrl": "string",
    "name": "string",
    "eventType": "WEBHOOK_EVENT_TYPE_UNSPECIFIED",
    "payload": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "modifiedDate": "2019-08-24T14:15:22Z",
    "archivedDate": "2019-08-24T14:15:22Z",
    "createdByUserId": "string",
    "modifiedByUserId": "string",
    "httpHeaders": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  }
}

Previous

BatchCreateWebhookLogs POST

Next

CreateOrUpdateWebhookSignatureKey POST