Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Increase Event Subscriptions API

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](https://dashboard.increase.com/developers/webhooks) or the API. For more information, see our [webhooks guide](https://increase.com/documentation/webhooks).

Increase Event Subscriptions API is one of 56 APIs that Increase publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Event Subscriptions. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 0.0.1.

Requests are made against 2 base URLs: https://api.increase.com, https://sandbox.increase.com.

4 operations 2 paths 5 schemas 2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.0.1
Base URL
https://api.increase.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Increase Event Subscriptions API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Event Subscriptions 4

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 Subs…

GET
/event_subscriptions
List Event Subscriptions
list_event_subscriptions 3 params → 2004XX5XX
POST
/event_subscriptions
Create an Event Subscription
create_an_event_subscription body → 2004XX5XX
GET
/event_subscriptions/{event_subscription_id}
Retrieve an Event Subscription
retrieve_an_event_subscription 1 param → 2004XX5XX
PATCH
/event_subscriptions/{event_subscription_id}
Update an Event Subscription
update_an_event_subscription 1 param body → 2004XX5XX

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are event_subscription (8 properties), create_an_event_subscription_parameters (5 properties), event_subscription_list (2 properties), update_an_event_subscription_parameters (1 property). Each schema is shown below with its type and property counts.

event_subscription_list
object
A list of Event Subscription objects.
2 properties 2 required
update_an_event_subscription_parameters
object
1 property
error
event_subscription
object
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…
8 properties 8 required
create_an_event_subscription_parameters
object
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

increase-event-subscriptions-api-openapi.yml Raw ↑

Other APIs Increase publishes across the network.

Increase Account Numbers API
Increase Account Statements API
Increase Account Transfers API
Increase Accounts API
Increase Ach Prenotifications API
Increase Ach Transfers API
Increase Card Disputes API
Increase Card Payments API
Increase Card Purchase Supplements API
Increase Card Push Transfers API
Increase Card Tokens API
Increase Card Validations API