Skip to content
RelayDocumentation

GuidesCore concepts

Endpoints

An endpoint is a URL that receives events, with its own subscriptions, secret and settings.

An endpoint is an HTTPS URL that receives events. Usually your customers create endpoints from your app (or the embedded portal) to get notified about their own data.

What an endpoint has

  • A URL that receives POST requests with a JSON body.
  • A list of event types it subscribes to, with wildcards (invoice.*).
  • A signing secret (whsec_…) used to verify signatures.
  • Optional filters, rate limit and custom headers.

Filtering events

A filter only delivers events whose payload matches. Filters use simple comparisons on data:

{
  "events": ["invoice.paid"],
  "filter": "data.amount >= 10000 && data.currency == 'usd'"
}

Disabling and pausing

If an endpoint fails every delivery for five consecutive days, Relay disables it and emails your team. Disabled endpoints keep their configuration; enable them again from the dashboard or with Update an endpoint.

You can also pause an endpoint yourself. Events sent while it is paused are queued for up to three days and delivered in order when you resume it.

Limits

FreeProScale
Endpoints per account101,000Unlimited
Event types per endpoint5050200
Custom headers31010