Skip to main content
WEBHOOK

Headers

​
X-Akhdar-Signature
string
required

HMAC-SHA256 signature of this delivery. Format: v1=<hex-encoded-hmac>. Computed over timestamp + "." + raw_request_body using the environment-scoped webhook signing secret, where timestamp is the exact X-Akhdar-Timestamp value and raw_request_body is the exact bytes sent before JSON parsing or reformatting. During an overlap window, current and previous secrets only (max two) may verify.

HMAC-SHA256 hex digest formatted as v1=<hex-encoded-hmac>. 64 hexadecimal characters are the SHA-256 digest encoding.

Pattern: ^v1=[0-9a-fA-F]{64}$
Example:

"v1=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"

​
X-Akhdar-Timestamp
string<date-time>
required

Delivery timestamp used as the HMAC timestamp string. ISO 8601 UTC. Must equal the envelope timestamp. Partner receivers must accept timestamps only within 5 minutes before or after receipt and must reject deliveries outside that tolerance.

ISO 8601 UTC timestamp.

Example:

"2026-08-03T12:00:00.000Z"

​
X-Akhdar-Event-ID
string
required

Logical event identifier. Must equal envelope event_id. Stable across retries and redelivery attempts. Partner receivers must use this value for idempotent processing.

Akhdar-generated logical webhook event identifier. Unique per business event. Stable across retries and redelivery attempts. Distinct from partner_event_id and from delivery_id.

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

"evt_wh_01HZX8A1B2C3D4E5F6G7H8J9"

​
X-Akhdar-Delivery-ID
string
required

Unique identifier for this delivery attempt. Must equal envelope delivery_id. A new value is allocated for every automatic retry and for platform redelivery. Manual replay does not create a new business event.

Akhdar-generated identifier for a single webhook delivery attempt. Unique per attempt, including automatic retries and redelivery attempts.

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

"dlv_01HZX8B2C3D4E5F6G7H8J9K0"

Body

application/json
​
event_id
string
required

Akhdar-generated logical webhook event identifier. Unique per business event. Stable across retries and redelivery attempts. Distinct from partner_event_id and from delivery_id.

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

"evt_wh_01HZX8A1B2C3D4E5F6G7H8J9"

​
delivery_id
string
required

Akhdar-generated identifier for a single webhook delivery attempt. Unique per attempt, including automatic retries and redelivery attempts.

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

"dlv_01HZX8B2C3D4E5F6G7H8J9K0"

​
event_type
enum<string>
required
Available options:
settlement.closed
Example:

"settlement.closed"

​
event_version
string
required

Event-contract version for the payload shape. Current deliveries use 1.

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

"1"

​
timestamp
string<date-time>
required

ISO 8601 UTC timestamp.

Example:

"2026-08-03T12:00:00.000Z"

​
data
object
required

Identifiers for settlement.closed. The payload remains identifier-only.

Response

Partner accepted the delivery. Any HTTP 2xx is success. Akhdar does not require a response body.