Skip to main content
POST
Create Global Webhook Subscription
A global subscription is owned by your API key’s user, not a single entity. It delivers events for every entity that user administers, including entities added later, so you register once and never re-subscribe as your access grows. Each delivery carries the originating entity in entity_id so you can route it to the right tenant.

Authorizations

x-api-key
string
header
required

Your Meow API key, sent in the x-api-key header for authentication.

Headers

Idempotency-Key
string
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.

Required string length: 1 - 50
Pattern: ^[!-~]+$

Body

application/json
name
string
required

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

Maximum string length: 255
url
string<uri>
required

HTTPS endpoint Meow POSTs each event to.

Required string length: 1 - 2048
event_types
enum<string>[] | null

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

Available options:
ach_transfer.created,
ach_transfer.updated,
wire_transfer.created,
wire_transfer.updated,
book_transfer.created,
book_transfer.updated,
international_payment.created,
international_payment.updated,
inbound_ach_transfer.created,
inbound_ach_transfer.updated,
inbound_wire_transfer.created,
inbound_wire_transfer.updated,
check_deposit.created,
check_deposit.updated,
global_account_transfer.created,
crypto_transfer.created,
crypto_transfer.updated,
account.created,
account.updated,
card.created,
card.updated,
onboarding_consent.updated,
info_request.created,
info_request.updated,
application.created,
application.under_review,
application.submitted,
application.approved,
application.rejected,
identity_verification.action_required,
identity_verification.approved,
identity_verification.rejected,
message.attempt.exhausted,
webhook.test
payload_mode
enum<string>
default:snapshot

How much of the resource each delivery carries. snapshot (the default) sends the full resource in data.object; thin sends only its id and object type, and you fetch the current state yourself.

Available options:
snapshot,
thin

Response

Successful Response

id
string<uuid>
required

Unique identifier for the subscription.

name
string
required

Label for the subscription.

url
string
required

Endpoint Meow POSTs each event to.

is_enabled
boolean
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_types
enum<string>[] | null
required

Event types this subscription receives. null means every event.

Available options:
ach_transfer.created,
ach_transfer.updated,
wire_transfer.created,
wire_transfer.updated,
book_transfer.created,
book_transfer.updated,
international_payment.created,
international_payment.updated,
inbound_ach_transfer.created,
inbound_ach_transfer.updated,
inbound_wire_transfer.created,
inbound_wire_transfer.updated,
check_deposit.created,
check_deposit.updated,
global_account_transfer.created,
crypto_transfer.created,
crypto_transfer.updated,
account.created,
account.updated,
card.created,
card.updated,
onboarding_consent.updated,
info_request.created,
info_request.updated,
application.created,
application.under_review,
application.submitted,
application.approved,
application.rejected,
identity_verification.action_required,
identity_verification.approved,
identity_verification.rejected,
message.attempt.exhausted,
webhook.test
payload_mode
enum<string>
required

How much of the resource each delivery carries: snapshot for the full resource, thin for its id and object type only.

Available options:
snapshot,
thin
created_time
string<date-time>
required

When the subscription was created.

updated_time
string<date-time>
required

When the subscription was last modified.

secret
string<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.