Skip to main content
POST
/
webhooks
/
subscriptions
Create Subscription
curl --request POST \
  --url https://api.meow.com/v1/webhooks/subscriptions \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "url": "<string>",
  "event_types": [],
  "payload_mode": "snapshot"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "url": "<string>",
  "is_enabled": true,
  "event_types": [],
  "created_time": "2023-11-07T05:31:56Z",
  "updated_time": "2023-11-07T05:31:56Z",
  "secret": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Your Meow API key for authentication

Headers

​
Idempotency-Key
string
required

Client-supplied unique key (1-50 chars). Keys are scoped to the calling entity across all webhook endpoints — reusing a key on any webhook POST/PATCH within the same entity returns 400.

Required string length: 1 - 50
​
x-entity-id
string<uuid>

Optional entity ID for scoped access to entity-specific data

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,
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,
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,
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,
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