/webhooks/{id}/test

Send a test payload to a webhook to verify it's working

Authentication Required

Authorization: Bearer {token} header string

This header is required to access this endpoint

x-account-id header string

Account ID for the request

id path integer

The ID of the webhook

{
  "payload": {}
}

{
  "payload": {}
}

Output:

Test webhook response

{
  "success": false,
  "statusCode": 0,
  "payload": {},
  "response": "string",
  "error": "string"
}

in: header
name: x-account-id
schema:
  type: string
description: Account ID for the request
required: true
example: "2311"

|
export type xAccountIdHeader = any; // Schema type not fully supported

Check out the source code for this route entrypoint here: /webhooks/[id]/test/route.ts

Or the swagger.yaml spec this documentation was generated from: /webhooks/swagger.yaml