increase-test
GET/event_subscriptions/{event_subscription_id}

Retrieve an event subscription

Retrieves a specific event subscription and its webhook configuration. Use event_subscription_id to identify the subscription whose status, URL, or selected event categories you need.

1 parameter
event_subscription_idstringrequired
The identifier of the event subscription to retrieve.

3 status codes
200Returns the event subscription object, including its identifier, status, webhook URL, selected event categories, and associated OAuth connection identifier.
created_atstringrequired
The time the event subscription was created.
idstringrequired
The event subscription identifier.
idempotency_keystringrequired
The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).
oauth_connection_idstringrequired
If specified, this subscription will only receive webhooks for Events associated with this OAuth Connection.
selected_event_categoriesarray<EventSubscriptionSelectedEventCategoriesElement>required
If specified, this subscription will only receive webhooks for Events with the specified `category`.
statusstringrequired
This indicates if we'll send notifications to this subscription.
Allowed:activedisableddeleted
typestringrequired
A constant representing the object's type. For this resource it will always be `event_subscription`.
Allowed:event_subscription
urlstringrequired
The webhook url where we'll send notifications.
4XXReturned when the request has a client-side error.
5XXReturned when the request encounters a server-side error.

Error handling

The event_subscription_id path parameter must identify an existing event subscription.