Send test event

Send a webhook_endpoint.test event to one endpoint.

POST /api/v1/webhook_endpoints/{webhook_endpoint_id}/test

cURL

curl -X POST "https://api.wordsmith.ai/api/v1/webhook_endpoints/0e7b3c5a-9d21-4f86-b4a0-6c8e2f1d7a39/test" \
  -H "Authorization: Bearer sk-ws-api1-your_api_key_here"

Response

{
  "delivery_id": "2a6c8e0f-1b3d-4f57-9a2c-4e6f8a0b2c4d",
  "event_id": "8d2f4a61-3c7e-4b09-a5d1-9e6f0b2c7a48"
}

Sends a signed webhook_endpoint.test event to this endpoint only. Use it to check your receiver. Follow the attempt with List deliveries.

​

Authentication

Requires an API key, or an OAuth token with webhooks:write.

​

Path parameters

webhook_endpoint_id · string · required

The endpoint.

​

Response

Returns the test event and its delivery.

cURL

curl -X POST "https://api.wordsmith.ai/api/v1/webhook_endpoints/0e7b3c5a-9d21-4f86-b4a0-6c8e2f1d7a39/test" \
  -H "Authorization: Bearer sk-ws-api1-your_api_key_here"

Response

{
  "delivery_id": "2a6c8e0f-1b3d-4f57-9a2c-4e6f8a0b2c4d",
  "event_id": "8d2f4a61-3c7e-4b09-a5d1-9e6f0b2c7a48"
}

​

Errors

Status	error_code	When
409	resource_conflict	The endpoint is turned off or failing. Turn it on first.
404	resource_not_found	No endpoint with this id that you can manage, or webhooks are not on for your organisation.