Webhooks

Send Test Webhook Event

Sends a test event to a webhook subscription and queues it for delivery so you can verify your endpoint and signature handling.

post/webhooks/subscriptions/{subscription_id}/test

Request

Base URL
https://api.meow.com/v1
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/meow/apis/meow-api/docs/webhooks/subscriptions/:subscription_id/test/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

subscription_idstring uuid required

The webhook subscription.

Headers

Idempotency-Keystring required

A unique key you generate (1-50 printable ASCII characters, no spaces) so retrying this request never creates a duplicate. Reusing a key is rejected.

x-entity-idstring uuid

Optional entity_id to scope requests to a specific entity.

Response

Successful Response

event_idstring uuid required

The webhook.test event that was created.

delivery_idstring uuid nullable required

Delivery created for the event, to inspect with Get Delivery. null if no delivery was created, in which case queued is false.

queuedboolean required

Whether the test event was queued for delivery. The test event bypasses the subscription's event-type filter, so it is sent even if the subscription does not select webhook.test.

Changes

No recorded changes to this operation across all 1 revision of this API.