Skip to main content
POST
/
platform
/
webhooks
Create a platform webhook
curl --request POST \
  --url https://api.arkhq.io/v1/platform/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Central Event Processor",
  "url": "https://myplatform.com/webhooks/email-events",
  "events": [
    "MessageSent",
    "MessageDeliveryFailed",
    "MessageBounced"
  ]
}
'
{
  "success": true,
  "data": {
    "id": "pwh_abc123def456",
    "name": "<string>",
    "url": "<string>",
    "events": [
      "MessageSent"
    ],
    "enabled": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "requestId": "req_V1StGXR8_Z5jdHi6"
  }
}

Authorizations

​
Authorization
string
header
required

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

Authorization: Bearer YOUR_API_KEY

Body

application/json
​
name
string
required

Display name for the webhook

Minimum string length: 1
Example:

"Central Event Processor"

​
url
string<uri>
required

Webhook endpoint URL (must be HTTPS)

Example:

"https://myplatform.com/webhooks/email-events"

​
events
enum<string>[]

Events to subscribe to. Empty array means all events.

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

Response

Platform webhook created

​
success
boolean
required
​
data
object
required
​
meta
object
required