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 supply in the Idempotency-Key header (1-50 characters). Keys are scoped to the webhook owner across all webhook POST endpoints. Reusing a key for the same owner returns 400.

Required string length: 1 - 50

Body

application/json
name
string
required
Maximum string length: 255
url
string<uri>
required
Required string length: 1 - 2048
event_types
enum<string>[] | null
Available options:
ach_transfer.created,
ach_transfer.updated,
wire_transfer.created,
wire_transfer.updated,
book_transfer.created,
book_transfer.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,
application.created,
application.under_review,
application.submitted,
application.approved,
application.rejected,
identity_verification.action_required,
identity_verification.approved,
identity_verification.rejected,
balance.updated,
message.attempt.exhausted,
webhook.test
payload_mode
enum<string>
default:snapshot
Available options:
snapshot,
thin

Response

Successful Response

id
string<uuid>
required
name
string
required
url
string
required
is_enabled
boolean
required
event_types
enum<string>[] | null
required
Available options:
ach_transfer.created,
ach_transfer.updated,
wire_transfer.created,
wire_transfer.updated,
book_transfer.created,
book_transfer.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,
application.created,
application.under_review,
application.submitted,
application.approved,
application.rejected,
identity_verification.action_required,
identity_verification.approved,
identity_verification.rejected,
balance.updated,
message.attempt.exhausted,
webhook.test
payload_mode
enum<string>
required
Available options:
snapshot,
thin
created_time
string<date-time>
required
updated_time
string<date-time>
required
secret
string<password>
required