Skip to main content
WEBHOOK
MessageHeld
{
  "event": "MessageHeld",
  "timestamp": 1704672000,
  "payload": {
    "message": {
      "id": "12345",
      "token": "abc123",
      "to": "[email protected]",
      "from": "[email protected]",
      "subject": "Welcome to our service",
      "tag": "onboarding",
      "message_id": "<[email protected]>"
    },
    "status": "Held",
    "details": "Message held for review"
  }
}

Authorizations

​
Authorization
string
header
required

Use your API key from arkhq.io/org/credentials

Authorization: Bearer YOUR_API_KEY

Body

application/json

Webhook event payload sent to your configured endpoint

​
event
enum<string>
required

The type of event that occurred

Available options:
MessageSent,
MessageDelayed,
MessageDeliveryFailed,
MessageBounced,
MessageHeld,
MessageLoaded,
MessageLinkClicked,
DomainDNSError
Example:

"MessageSent"

​
timestamp
integer
required

Unix timestamp when the event occurred

Example:

1704672000

​
payload
object
required

Event-specific data

Response

200

Webhook received successfully