Test Webhook

Send a test event to a webhook endpoint and return the result.

Bearer token or X-API-Keyscope: adminoperation_id: webhooks.test

Authentication

Send either Authorization: Bearer <token> or X-API-Key: <token>. The caller must hold the "admin" role on the organization. Any org token with sufficient scope. Create tokens from the console or the /v1/orgs/{org_id}/tokens endpoints. Requests without a valid credential are rejected with 401.

SDK install

pip install znyx-sdknpm install @znyx/sdk

Code samples

Request

curl -X POST "$ZNYX_API_URL/v1/orgs/00000000-0000-0000-0000-000000000000/webhooks/00000000-0000-0000-0000-000000000000/test" \
  -H "Authorization: Bearer $ZNYX_TOKEN"

Response

application/json

Successful Response

{}

Schema: object

Path parameters

Name	Type	Required	Description
org_id#path	string	required	-
webhook_id#path	string	required	-

Header parameters

Name	Type	Required	Description
X-API-Key#header	string \| null	optional	-
authorization#header	string \| null	optional	-

Responses

Status	Description
200	Successful Response
422	Validation Error

Response schema

object

Errors & what triggers them

Code	Trigger	Fix
401	Missing or expired Authorization header.	-
403	Token does not have the required role (admin / editor).	-
404	Target resource does not exist in this org.	-
422	Request body failed validation.	-