Sign in

v47

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-012382333.4 MB

Create an Event Subscription

post/event_subscriptions

Request body

oauth_connection_idstring

If specified, this subscription will only receive webhooks for Events associated with the specified OAuth Connection.

shared_secretstring

The key that will be used to sign webhooks. If no value is passed, a random string will be used as default.

status'active' | 'disabled'

The status of the event subscription. Defaults to active if not specified.

urlstring required

The URL you'd like us to send webhooks to.

Example request

{
  "url": "https://website.com/webhooks"
}

Response

Event Subscription

created_atstring date-time required

The time the event subscription was created.

idstring required

The event subscription identifier.

idempotency_keystring nullable required

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.

oauth_connection_idstring nullable required

If specified, this subscription will only receive webhooks for Events associated with this OAuth Connection.

status'active' | 'disabled' | 'deleted' | 'requires_attention' required

This indicates if we'll send notifications to this subscription.

type'event_subscription' required

A constant representing the object's type. For this resource it will always be event_subscription.

urlstring required

The webhook url where we'll send notifications.

Example response

{
  "created_at": "2020-01-31T23:59:59Z",
  "id": "event_subscription_001dzz0r20rcdxgb013zqb8m04g",
  "idempotency_key": null,
  "oauth_connection_id": null,
  "selected_event_categories": null,
  "status": "active",
  "type": "event_subscription",
  "url": "https://website.com/webhooks"
}