Skip to main content
POST
Ruby

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body for creating a new webhook.

url
string
required

The HTTPS URL to deliver webhook events to.

events
enum<string>[]
required

List of event types that will trigger this webhook.

Email lifecycle event type that can trigger a webhook delivery.

Available options:
accepted,
processed,
bounced,
delivered,
opened,
clicked,
complained,
unsubscribed,
resubscribed
channelId
string<uuid>

Optional channel scope. If set, only events for this channel trigger the webhook.

additionalHeaders
object[]

Custom headers to include in each webhook request. Each header name is prefixed with X-Customer-.

enabled
boolean

Whether the webhook is active or not. Defaults to true.

Response

OK

Webhook configuration properties.

id
string<uuid>

Unique identifier for the webhook.

channelId
string<uuid> | null

Channel this webhook is scoped to, or null for account-wide.

url
string

The HTTPS URL events are delivered to.

payloadSigningKey
string

HMAC-SHA256 signing key used to verify webhook authenticity. Sent as the X-Helo-Webhook-Signature request header on each delivery.

enabled
boolean

Whether the webhook is active and will receive events.

additionalHeaders
object[]

Custom headers sent with each webhook delivery.

events
enum<string>[]

Event types that trigger this webhook.

Email lifecycle event type that can trigger a webhook delivery.

Available options:
accepted,
processed,
bounced,
delivered,
opened,
clicked,
complained,
unsubscribed,
resubscribed
lastResponse
object | null

The most recent delivery outcome for this webhook, or null if no delivery has been attempted yet.