Events and Event Subscriptions. Every change in Increase produces an
Event ({id, category, associated_object_type, associated_object_id, created_at}); Event Subscriptions deliver them to your webhook URL.
Events are deliberately thin: re-fetch the object they point at with
fetch-associated-object before acting, and make your handler
idempotent on the event id (deliveries can repeat). Events stay
listable for 30 days, so a periodic list-events poll in ascending
order backstops missed webhooks.
Functions
create-event-subscription
fn (params: Map): Map
fn (params: Map, opts: Map): Map
POST /event_subscriptions: deliver Events to a webhook url.
Optional: selected_event_categories ([{event_category: "ach_transfer.updated"}]; omit for every category), shared_secret
(the key Increase signs deliveries with; omit for a random one),
status ("active" or "disabled"), oauth_connection_id. Store
the secret as increase.webhook.secret.
Example
::increase::events/create-event-subscription({url: "https://example.com/increase/webhook"},
{idempotency-key: "webhook-main"})
delete-event-subscription
fn (event-subscription-id: Str): Map
fn (event-subscription-id: Str, opts: Map): Map
Delete an Event Subscription (PATCH {status: "deleted"}; Increase has no DELETE endpoint). Permanent.
fetch-associated-object
fn (event: Any): Map
fn (event: Any, opts: Map): Map
Re-fetch the object an Event points at (GET by
associated_object_type and associated_object_id). This is the
current state of the object, which is what a handler should act on.
A few object types have no retrieve endpoint; those come back as the
API's HttpError.
Example
e ::increase::events/parse-event(request.body)
transfer ::increase::events/fetch-associated-object(e)
transfer.status // => "submitted"
get-event
fn (event-id: Str): Map
fn (event-id: Str, opts: Map): Map
GET /events/{event_id}: retrieve an Event.
get-event-subscription
fn (event-subscription-id: Str): Map
fn (event-subscription-id: Str, opts: Map): Map
GET /event_subscriptions/{event_subscription_id}: retrieve an Event Subscription.
list-event-subscriptions
fn (): Map
fn (params: Map): Map
fn (params: Map, opts: Map): Map
GET /event_subscriptions: one page of Event Subscriptions. Filters: idempotency_key, limit, cursor.
list-events
fn (): Map
fn (params: Map): Map
fn (params: Map, opts: Map): Map
GET /events: one page of Events, newest first by default. Filters:
associated_object_id, "category.in" (e.g.
["ach_transfer.updated"]), created_at, order_by: {field: "created_at", direction: "ascending"} (for polling from a stored
cursor), limit, cursor.
Example
page ::increase::events/list-events({"category.in": ["ach_transfer.updated"], order_by: {field: "created_at", direction: "ascending"}})
object-path
fn (event: Any): Str
The retrieve path for an Event's associated object, e.g. /ach_transfers/ach_transfer_uoxatyh3lt5evrsdvo7q, or an Err when the event names no object. Exposed for testing.
parse-event
fn (payload: Any): Event
The routing fields of an Event payload (a decoded Map, or the raw
JSON text of a webhook body), as an Event. Fields Increase didn't
send are null. Errs when the body isn't a JSON object.
Example
e ::increase::events/parse-event("{\\"id\\":\\"event_001\\",\\"category\\":\\"ach_transfer.updated\\",\\"associated_object_type\\":\\"ach_transfer\\",\\"associated_object_id\\":\\"ach_transfer_uoxatyh3lt5evrsdvo7q\\",\\"created_at\\":\\"2026-11-01T12:00:00Z\\",\\"type\\":\\"event\\"}")
e.category // => "ach_transfer.updated"
resource-name
fn (object-type: Str): Str
The API collection for an object type: "ach_transfer" is "ach_transfers", "entity" is "entities", "lockbox_address" is "lockbox_addresses", "inbound_real_time_payments_request_for_payment" is "inbound_real_time_payments_requests_for_payment". Exposed for testing.
update-event-subscription
fn (event-subscription-id: Str, status: Str): Map
fn (event-subscription-id: Str, status: Str, opts: Map): Map
PATCH /event_subscriptions/{event_subscription_id}: set status to "active", "disabled" (pause deliveries) or "deleted" (permanent).
Types
Event
Event type {
id: Str?,
category: Str?,
associated_object_type: Str?,
associated_object_id: Str?,
created_at: Str?
}
The fields of an Increase Event that a handler routes on. category is e.g. "ach_transfer.updated"; associated_object_type and associated_object_id name the object to re-fetch.