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

Request Body

application/jsonRequired

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

`webhookId`string

`webhook`object

`createRequest`object

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

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

A successful response.

{
  "httpResponseCode": 0,
  "httpResponseBody": "string"
}

Request Body

webhookIdstring

webhookobject

Attributes

createRequestobject

Attributes

Response

`webhookId`string

`webhook`object

`createRequest`object