GET
/
event_subscriptions
curl --request GET \
  --url https://api.useswift.dev/event_subscriptions \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "type": "object",
      "title": "Event Subscription",
      "description": "Event Subscriptions are used to receive webhooks when Events occur. They can be configured via the Dashboard or via the API.",
      "example": {
        "created_at": "2024-01-31T23:59:59Z",
        "event_category": "account.created",
        "id": "event_subscription_vjb43lkAdf934jb13Df93",
        "url": "https://example.com/webhook"
      },
      "properties": {
        "created_at": {
          "oneOf": [
            {
              "type": "string",
              "format": "date-time",
              "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Event Subscription was created."
            }
          ]
        },
        "event_category": {
          "oneOf": [
            {
              "type": "string",
              "description": "The available categories for Events.",
              "enum": [
                "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"
              ],
              "x-enum-descriptions": [
                "Occurs whenever an Entity is created.",
                "Occurs whenever an Entity is updated.",
                "Occurs whenever an Account is created.",
                "Occurs whenever an Account is updated.",
                "Occurs whenever a User is created.",
                "Occurs whenever a User is updated.",
                "Occurs whenever a User Bank is created.",
                "Occurs whenever a User Bank is updated.",
                "Occurs whenever a Venmo Account is created.",
                "Occurs whenever a Venmo Account is updated.",
                "Occurs whenever a Venmo Request is created.",
                "Occurs whenever a Venmo Request is updated.",
                "Occurs whenever a Zelle Account is created.",
                "Occurs whenever a Zelle Account is updated.",
                "Occurs whenever a Zelle Request is created.",
                "Occurs whenever a Zelle Request is updated.",
                "Occurs whenever a Real-time Payments Request is created.",
                "Occurs whenever a Real-time Payments Request is updated.",
                "Occurs whenever a FedNow Request is created.",
                "Occurs whenever a FedNow Request is updated.",
                "Occurs whenever a Wire Transfer is created.",
                "Occurs whenever a Wire Transfer is updated.",
                "Occurs whenever an Event Subscription is created.",
                "Occurs whenever an Event Subscription is updated."
              ]
            },
            {
              "type": "null",
              "description": "The available categories for Events.",
              "enum": [
                "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"
              ],
              "x-enum-descriptions": [
                "Occurs whenever an Entity is created.",
                "Occurs whenever an Entity is updated.",
                "Occurs whenever an Account is created.",
                "Occurs whenever an Account is updated.",
                "Occurs whenever a User is created.",
                "Occurs whenever a User is updated.",
                "Occurs whenever a User Bank is created.",
                "Occurs whenever a User Bank is updated.",
                "Occurs whenever a Venmo Account is created.",
                "Occurs whenever a Venmo Account is updated.",
                "Occurs whenever a Venmo Request is created.",
                "Occurs whenever a Venmo Request is updated.",
                "Occurs whenever a Zelle Account is created.",
                "Occurs whenever a Zelle Account is updated.",
                "Occurs whenever a Zelle Request is created.",
                "Occurs whenever a Zelle Request is updated.",
                "Occurs whenever a Real-time Payments Request is created.",
                "Occurs whenever a Real-time Payments Request is updated.",
                "Occurs whenever a FedNow Request is created.",
                "Occurs whenever a FedNow Request is updated.",
                "Occurs whenever a Wire Transfer is created.",
                "Occurs whenever a Wire Transfer is updated.",
                "Occurs whenever an Event Subscription is created.",
                "Occurs whenever an Event Subscription is updated."
              ]
            }
          ]
        },
        "id": {
          "oneOf": [
            {
              "type": "string",
              "description": "The Event Subscription's unique identifier."
            }
          ]
        },
        "url": {
          "oneOf": [
            {
              "type": "string",
              "description": "The URL that the Event Subscription will send webhooks to."
            }
          ]
        }
      },
      "required": [
        "created_at",
        "event_category",
        "id",
        "url"
      ],
      "x-title-plural": "Event Subscriptions",
      "x-tag": "Event Subscriptions"
    }
  ],
  "next_cursor": "Y3Vyc29y"
}

Authorizations

Authorization
string
header
required

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

Query Parameters

cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

Required range: 1 <= x <= 100
event_category
string

Filter the list of Event Subscriptions by category.

Response

200
application/json
Event Subscriptions

A list of Event Subscription objects.

data
object[]
required

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

next_cursor
string | null
required

A pointer to a place in the list.