Reference

Event types

Event type	Reference type
`account.opened`	`ACCOUNT`
`iban.assigned`	`ACCOUNT`
`deposit.received`	`TRANSACTION`
`payment.received`	`TRANSACTION`
`payout.completed`	`TRANSACTION`
`payout.failed`	`TRANSACTION`
`transaction.updated`	`TRANSACTION`
`kyc.completed`	`USER`
`kyc.rejected`	`USER`
`customer.created`	`USER`

Endl manages this catalogue and may add event types over time. Handle an unrecognised eventType gracefully rather than rejecting it, or a new event type becomes an outage in your receiver.

Subscribe with globs — payout.* — to pick up related types automatically as they are added.

A delivered body carries exactly the fields the producing service sent for that event, with every leaf value rendered as a string. The field set is producer-defined, not a fixed schema per event type.

Delivery modes

Mode	Status	Notes
`PUSH`	Available	Signed HTTPS `POST` to your target.
`PULL`	Available	Poll the event feed. No target.
`SQS`	Not available	Reserved. Returns `422`.
`SSE`	Not available	Reserved. Returns `422`.

Subscription status

Status	Meaning
`ACTIVE`	Delivering. Counts against your active cap.
`PAUSED`	Paused by you. Events are held, not dropped.
`SUSPENDED`	Paused by Endl after repeated failures. You cannot set this yourself.
`DELETED`	Soft-deleted. Not returned by get or list.

Delivery status

Status	Meaning	Terminal
`QUEUED`	Ready to deliver.	No
`PENDING_SUBSCRIPTION`	Held because the subscription is paused or suspended. Drains on resume.	No
`DELIVERING`	Being attempted now.	No
`RETRYING`	Waiting for the next attempt.	No
`DELIVERED`	A `2xx` was received.	Yes
`FAILED`	Permanent error, or the attempt budget was exhausted.	Yes
`EXPIRED`	Passed the hard deadline.	Yes
`CANCELLED`	The subscription was deleted before delivery.	Yes

Only FAILED and EXPIRED deliveries can be retried.

Error classes

lastErrorClass on a delivery is one of: TIMEOUT · CONNECT · DNS · TLS · REDIRECT · HTTP_4XX · HTTP_4XX_TRANSIENT · HTTP_5XX · PAYLOAD_TOO_LARGE · SSRF_BLOCKED · UNRESOLVABLE_REF

Limits

Limit	Value
Active subscriptions per partner	5 by default
`target` length	512 characters
Page size (`limit`)	Default 25, maximum 100
Codes counted as delivered	Any `2xx`

Get started

Endpoints

Conventions

Event types

Delivery modes

Subscription status

Delivery status

Error classes

Limits

​Event types

​Delivery modes

​Subscription status

​Delivery status

​Error classes

​Limits

Event types

Delivery modes

Subscription status

Delivery status

Error classes

Limits