GET
/
event_subscriptions
/
{event_subscription_id}
Retrieve an Event Subscription
curl --request GET \
  --url https://api.useswift.dev/event_subscriptions/{event_subscription_id} \
  --header 'Authorization: Bearer <token>'
{
  "created_at": "2024-01-31T23:59:59Z",
  "event_category": "account.created",
  "id": "event_subscription_vjb43lkAdf934jb13Df93",
  "url": "https://example.com/webhook"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
event_subscription_id
string
required

The identifier of the Event Subscription to retrieve.

Response

Event Subscription

Event Subscriptions are used to receive webhooks when Events occur. They can be configured via the Dashboard or via the API.

​
created_at
string<date-time>
required

The ISO 8601 time at which the Event Subscription was created.

​
event_category
enum<string> | null
required

The available categories for Events.

Available options:
entity.created,
entity.updated,
account.created,
account.updated,
user.created,
user.updated,
user_bank.created,
user_bank.updated,
venmo_account.created,
venmo_account.updated,
venmo_request.created,
venmo_request.updated,
zelle_account.created,
zelle_account.updated,
zelle_request.created,
zelle_request.updated,
rtp_request.created,
rtp_request.updated,
fednow_request.created,
fednow_request.updated,
wire_transfer.created,
wire_transfer.updated,
event_subscription.created,
event_subscription.updated
​
id
string
required

The Event Subscription's unique identifier.

​
url
string
required

The URL that the Event Subscription will send webhooks to.