Skip to main content
POST
cURL
Read the recovery rules before retrying a write. Keep the same key and body for the same logical operation.

Authorizations

Authorization
string
header
required

ex_test_ or ex_live_ key issued by an Emailx operator. Never use provider keys or session cookies.

Headers

Idempotency-Key
string
required

Unique per logical mutation. Same path and body replay for 24 hours.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_.:/-]+$

Path Parameters

workspace_id
integer
required

Emailx workspace (Clients) ID, not the agency workspace link ID.

Required range: x >= 1

Body

application/json

HTTPS on a public address only. Saving does not contact the URL; send a test event to check it.

url
string<uri>
required
Required string length: 9 - 2000
event_types
enum<string>[]
required
Required array length: 1 - 6 elements
Available options:
operation.succeeded,
operation.partially_succeeded,
operation.failed,
operation.cancelled,
operation.needs_reconciliation,
operation.awaiting_user_action
description
string
Maximum string length: 255

Response

Created

data
object
required