Skip to main content
WEBHOOK

Headers

​
X-Helo-Webhook-Signature
string
required

HMAC-SHA256 signature of the request, formatted as t={timestamp},v1={signature}. Verify it against the webhook's signing key to authenticate the delivery.

​
X-Helo-Webhook-Event-Id
string<uuid>
required

Unique identifier of the event, useful for idempotent processing.

​
X-Helo-Webhook-Id
string<uuid>
required

Unique identifier of the webhook.

​
X-Helo-Channel-Id
string<uuid>

Unique identifier of the channel associated with the webhook, if applicable.

​
X-Helo-Webhook-Test
enum<string>

Set to true when the delivery is a test, otherwise omitted.

Available options:
true

Body

application/json

Payload delivered when a return path domain is verified.

​
timestamp
string<date-time>
required

When the event occurred (ISO 8601 / RFC 3339).

​
domainId
string<uuid>
required

Unique identifier for the domain.

​
domainName
string
required

The name of the domain.

​
dnsRecordHost
string
required

The host for the DNS record.

​
eventType
enum<string>
required
Available options:
return-path-domain-verified

Response

2XX

Return any 2XX status code to acknowledge receipt.