MEmeow
Webhooks

Create Webhook Subscription

Creates a webhook subscription for your entity and returns it along with the signing secret. The secret is returned only once, so store it now to verify delivery signatures.

post/webhooks/subscriptions

Request

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.

Request body

namestring required

Label for the subscription, for your own reference. Must not be blank.

urlstring uri required

HTTPS endpoint Meow POSTs each event to.

event_typesWebhookEventType[] nullable

Event types to deliver. Omit or send null to receive every event. An empty list is rejected, since it would match nothing.

payload_mode'snapshot' | 'thin'
account_idstring nullable

Receive only this bank account's lifecycle and transfer events. Use a cash_account_ ID from GET /accounts. Omit or send null for all entity events. The account cannot be changed after creation. Book transfer events belong to the source account.

Response

Successful Response

account_idstring nullable

Bank account whose events this subscription receives. Null means no account filter. Fixed at creation.

idstring uuid required

Unique identifier for the subscription.

namestring required

Label for the subscription.

urlstring required

Endpoint Meow POSTs each event to.

is_enabledboolean required

Whether the subscription is currently receiving deliveries. Meow sets this to false after repeated delivery failures, a 410 Gone response, or an unsafe URL; re-enable it with a PATCH.

event_typesWebhookEventType[] nullable required

Event types this subscription receives. null means every event.

payload_mode'snapshot' | 'thin' required
created_timestring date-time required

When the subscription was created.

updated_timestring date-time required

When the subscription was last modified.

secretstring password required

Signing secret for verifying delivery signatures. Returned only when the subscription is created and when you rotate the secret — Meow cannot show it again, so store it now.

Changes

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