Skip to main content
GET
/
event_subscriptions
List
curl --request GET \
  --url https://api.ngrok.com/event_subscriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'ngrok-version: <ngrok-version>'
{
  "event_subscriptions": [
    {
      "id": "<string>",
      "uri": "<string>",
      "created_at": "<string>",
      "metadata": "<string>",
      "description": "<string>",
      "sources": [
        {
          "type": "<string>",
          "uri": "<string>"
        }
      ],
      "destinations": [
        {
          "id": "<string>",
          "uri": "<string>"
        }
      ]
    }
  ],
  "uri": "<string>",
  "next_page_uri": "<string>"
}

Authorizations

Authorization
string
header
required

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

Headers

ngrok-version
integer
default:2
required

Query Parameters

before_id
string
limit
string

Response

200 - application/json

List this Account's Event Subscriptions.

event_subscriptions
object[]

The list of all Event Subscriptions on this account.

uri
string

URI of the Event Subscriptions list API resource.

next_page_uri
string

URI of next page, or null if there is no next page.