Skip to main content
PATCH
Update Global Webhook Subscription

Authorizations

x-api-key
string
header
required

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

Path Parameters

subscription_id
string<uuid>
required

The webhook subscription.

Body

application/json
name
string | null

New label for the subscription. Omit to leave it unchanged.

Maximum string length: 255
url
string<uri> | null

New HTTPS endpoint to POST events to. Omit to leave it unchanged.

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

Replacement list of event types to deliver. Omit to leave the current selection unchanged. An empty list is rejected.

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
rotate_secret
boolean
default:false

Issue a new signing secret. The new plaintext secret is returned once in this response and never again.

is_enabled
boolean | null

Set to true to re-enable a subscription Meow disabled after repeated delivery failures, a 410 Gone response, or an unsafe URL. The subscription keeps its id and delivery history. Omit to leave it unchanged.

payload_mode
enum<string> | null

New payload mode. Applies to events fanned out from here on; deliveries already queued keep the mode they were created with. Omit to leave it unchanged.

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.