Send a test event

Send an example payload for an event to the subscription's URL right now, with the same token headers real deliveries carry plus X-Webhook-Test: true. Works even while the subscription is paused.

POST https://api.centerfy.ai/webhooks/inbound/outbound-webhooks/:id/test

Headers

Header	Required	Value	Description
`x-api-key`	Yes	your sub-account API key (cfy_…)	Authenticates the request; or use Authorization: Bearer `<key>`.

Path parameters

Name	Type	Required	Description
`id`	`string (uuid)`	Yes	The outbound webhook subscription id.

Body parameters

Name	Type	Required	Default	Description
`event`	`string`	No	—	Event to simulate; any supported event. Defaults to the subscription’s first event.

Request body

{
  "event": "contact.created"
}

Example

curl -X POST "https://api.centerfy.ai/webhooks/inbound/outbound-webhooks/{id}/test" \
  -H "x-api-key: $CENTERFY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "event": "contact.created"
}'

import { CenterfyClient } from "@centerfy/sdk";

const centerfy = new CenterfyClient({ apiKey: process.env.CENTERFY_API_KEY! });

const result = await centerfy.outboundWebhooks.test("<webhookId>", {
  "event": "contact.created"
});
console.log(result);

centerfy outboundWebhooks test <webhookId> '{"event":"contact.created"}'

MCP tool: centerfy_outbound_webhooks_test (see MCP server)

Response

{
  "status": "success",
  "webhook_id": "6f7a8b9c-0d1e-4f2a-8b3c-4d5e6f7a8b9c",
  "event": "contact.created",
  "delivered": false,
  "response_status": 500,
  "error": "endpoint responded 500"
}

Errors

400 — if no valid event is given or the stored url is not a public http(s) URL.
404 — if the subscription is not in this sub-account.

Notes

delivered is true when your endpoint answers 2xx within 10 seconds; error is only present when it isn’t. Redirects are not followed. The test is not recorded in deliveries. The request itself returns 200 either way.