Skip to main content
POST
/
event_subscriptions
Create
curl --request POST \
  --url https://api.ngrok.com/event_subscriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'ngrok-version: <ngrok-version>' \
  --data '{
  "metadata": "<string>",
  "description": "<string>",
  "sources": [
    {
      "type": "<string>"
    }
  ],
  "destination_ids": [
    "<string>"
  ]
}'
{
  "id": "<string>",
  "uri": "<string>",
  "created_at": "<string>",
  "metadata": "<string>",
  "description": "<string>",
  "sources": [
    {
      "type": "<string>",
      "uri": "<string>"
    }
  ],
  "destinations": [
    {
      "id": "<string>",
      "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

Body

application/json
​
metadata
string

Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.

​
description
string

Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.

​
sources
object[]

Sources containing the types for which this event subscription will trigger

​
destination_ids
string[]

A list of Event Destination IDs which should be used for this Event Subscription.

Response

201 - application/json

Create an Event Subscription.

​
id
string

Unique identifier for this Event Subscription.

​
uri
string

URI of the Event Subscription API resource.

​
created_at
string

When the Event Subscription was created (RFC 3339 format).

​
metadata
string

Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.

​
description
string

Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.

​
sources
object[]

Sources containing the types for which this event subscription will trigger

​
destinations
object[]

Destinations to which these events will be sent