Skip to content
Helpdox
Relay API

Documentation

Browse all docs →
Search docs…⌘K
Open a ticket
v2
Feedback

Receive delivery webhooks

Relay posts an event to your endpoint whenever a message is queued, delivered, opened or fails.

2 min read v2

You are reading the v2 docs of Relay API. Go to the latest version (v3) →

On this page

Relay posts an event to your endpoint whenever a message is queued, delivered, opened or fails. Follow the steps below — it takes just a few minutes.

Before you begin#

  • A Relay account and a test-mode API key
  • curl or one of the official SDKs

Steps#

  1. Add an endpoint#

    Developers → Webhooks → Add endpoint. Choose the events you want.

  2. Return 2xx quickly#

    Acknowledge within 5 seconds and process the event in a background job.

  3. Handle retries#

    Failed deliveries retry with backoff for 72 hours.

Tip

Events can arrive out of order — compare created_at.

Still stuck?#

Include the request ID from the Relay-Request-Id response header — it lets us find your call in seconds.

Was this article helpful?

Related articles