TestWebhook

Test an existing webhook or a webhook create request. This RPC will attempt to send an actual webhook with the provided parameters and forward back the response from the target.

POST /api/v1/webhooks:test

TestWebhook

cURL

curl --request POST \
  --url https://api.siftstack.com/api/v1/webhooks:test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "webhookId": "<string>"
}
'

200

{
  "httpResponseCode": 123,
  "httpResponseBody": "aSDinaTvuI8gbWludGxpZnk="
}

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_TestWebhook to test an existing webhook or a webhook create request.

The request for a call to WebhookService_TestWebhook to test an existing webhook or a webhook create request.

webhookId · string

webhook · object

Show child attributes

createRequest · object

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

Show child attributes

Response

200

application/json

A successful response.

The response of a call to WebhookService_TestWebhook. The response code and body will come from the HTTP response from the target URL.

httpResponseCode · integer<int64> · required

httpResponseBody · string<byte> · required