Sign inGet Started
Get started
Guides
API Reference
SDKs
CLI
Knowledge Base
Changelog

Idempotency

Networks fail at the worst moments: you POST a send, the connection drops, and now you don't know whether the email went out. Idempotency lets you retry that request safely. Send the same Idempotency-Key header again and Bird replays the original response instead of processing the request a second time.

How it works

Idempotency is opt-in. Add an Idempotency-Key header to a supported POST, PATCH, PUT, or DELETE request. Requests without it are processed normally with no deduplication. GET requests ignore the header.
On the customer API, workspace- and organization-scoped mutations support the response replay described below. User-only and unscoped unauthenticated operations and streams bypass it. Operations with a separate replay contract define their behavior in their reference page. For example, Create a voice call retains the original acceptance snapshot for matching retries when you supply a key.
The SDKs generate a key for each mutating call and reuse it for automatic retries, including call creation. You do not need to supply one for automatic SDK retries. Supply your own when one intended operation spans separate SDK calls, such as a retry after restarting your application. These examples show that case.
await bird.email.send(
  {
    from: "hello@yourdomain.com",
    to: ["delivered@messagebird.dev"],
    subject: "Welcome!",
    html: "<p>Thanks for signing up.</p>",
  },
  { idempotencyKey: "welcome-user/usr_abc123" },
);
A key is any nonempty string up to 255 characters. An empty header value skips deduplication. The recommended format is a deterministic key derived from your own entities, <event-type>/<entity-id> (for example welcome-user/usr_abc123), so retries across process restarts share a key; a random UUID per logical operation works too. The Bird SDKs generate a UUID key automatically for every mutating request and reuse it across their internal retries.
Keys are scoped to your workspace, or to your organization on organization-level endpoints. A completed response is kept for 3 hours; a retry after that window is processed as a fresh request. The window covers typical retry schedules. No deduplication record remains after it expires.

Replays

When Bird sees a key it has already completed, it returns the cached response, same status code, same body, without re-running the request. Replayed responses carry one extra header so you can tell them apart from fresh processing:
Code example
HTTP/1.1 202 Accepted
Idempotency-Replay: true
Retained responses can include 4xx rejections. Use a new key when correcting a request: if its rejection was retained, an unchanged retry replays it, and a changed request returns 409 E01005 IdempotencyKeyReuse. 5xx responses are not retained, so retry them with the same key and request.

Failure modes

ScenarioResponse
Same key, same request, original completedCached response replayed with Idempotency-Replay: true
Same key, different request body or endpoint409, E01005 IdempotencyKeyReuse
Same key, original request still in flight409, E01004 RequestInProgress
Key longer than 255 characters on an endpoint declaring the header422, E01001 ValidationError
Idempotency protection unavailable before execution503, E01033 IdempotencyUnavailable; this attempt is not executed
Reusing a completed key with a different request is treated as a client bug: Bird returns 409 immediately rather than silently handing you a response that doesn't match what you sent. Generate a new key for the new request. The comparison covers the method, endpoint, path and query parameters, and the raw request body, including JSON whitespace. Multipart uploads compare part names, filenames, and contents; boundaries and part ordering do not affect replay.
RequestInProgress means a concurrent request with the same key hasn't finished yet, typically an aggressive client-side timeout retrying while the first attempt is still processing. The in-flight lock expires within 30 seconds, so wait briefly and retry. See Errors for the envelope these come wrapped in.

What's not cached

5xx responses are never cached. The key unlocks and Bird can process a retry as a new attempt. Retry 5xx responses and timeouts with backoff using the same key and request. An operation can take effect before its response is retained; if that response is lost, or the in-flight lock expires, a retry can execute the operation again.
If idempotency protection is unavailable before execution, the API returns 503 E01033 IdempotencyUnavailable without executing this attempt. Keep the key on every retry. This error does not describe the outcome of an earlier attempt with the same key.

Practical guidance

  • Generate one key per logical operation and reuse it for every HTTP attempt of that operation.
  • Retry on network errors, timeouts, and 5xx with exponential backoff, reusing the same key each time.
  • Treat 409 IdempotencyKeyReuse as a bug in your key generation. Do not retry it.
  • Keys are optional on mutations. Use one when you need retry protection; omit it on GET requests.

Next steps

Related resources

Continue with the documentation, guides and examples for this topic. Resources are in English.

Watch the guideOrder confirmation emailsExplore the capabilityOrder confirmation emailsFollow the learning pathBuild your first integrationImplementation guideVoice sequences