Docs
Guides
Explanatory and how-to content
API Reference
Technical documentation
Changelog
Release notes
Dashboard
Manage your account
Status
Service status
API Reference
Event Subscriptions

Webhooks are event notifications we send to you by HTTPS POST requests. Event Subscriptions are how you configure your application to listen for them. You can create an Event Subscription through your developer dashboard or the API. For more information, see our webhooks guide.

The Event Subscription object
{
  "created_at": "2020-01-31T23:59:59Z",
  "id": "event_subscription_001dzz0r20rcdxgb013zqb8m04g",
  "idempotency_key": null,
  "oauth_connection_id": null,
  "selected_event_category": null,
  "status": "active",
  "type": "event_subscription",
  "url": "https://website.com/webhooks"
}
Attributes
created_at
string

The time the event subscription was created.

id
string

The event subscription identifier.

idempotency_key
string
Nullable

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_id
string
Nullable

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

selected_event_category
enum
Nullable

If specified, this subscription will only receive webhooks for Events with the specified category.

status
enum

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

type
string

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

url
string

The webhook url where we'll send notifications.

List Event Subscriptions
curl \
  --url "${INCREASE_URL}/event_subscriptions" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
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.

idempotency_key
string

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

200 character maximum
Create an Event Subscription
curl -X "POST" \
  --url "${INCREASE_URL}/event_subscriptions" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "url": "https://website.com/webhooks"
  }'
Parameters
oauth_connection_id
string

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

200 character maximum
selected_event_category
enum

If specified, this subscription will only receive webhooks for Events with the specified category.

shared_secret
string

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

100 character maximum
url
string
Required

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

Retrieve an Event Subscription
curl \
  --url "${INCREASE_URL}/event_subscriptions/event_subscription_001dzz0r20rcdxgb013zqb8m04g" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
event_subscription_id
string
Required

The identifier of the Event Subscription.

Update an Event Subscription
curl -X "PATCH" \
  --url "${INCREASE_URL}/event_subscriptions/event_subscription_001dzz0r20rcdxgb013zqb8m04g" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{}'
Parameters
event_subscription_id
string
Required

The identifier of the Event Subscription.

status
enum

The status to update the Event Subscription with.