grant.backfill_completed

POST

A history backfill of a grant ended: every mail in its range was handed to delivery (status: done), or it was cancelled. The last message.received of the run may follow seconds later.

Authorizations

• apiKey
• grantToken

Parameters

Header Parameters

x-inboxcnx-signature

required

t=<unix seconds>,v1=<hex HMAC-SHA256>. The MAC covers <t>.<raw body> with the endpoint’s signing secret. During a secret rotation a second v1 carries the previous secret’s MAC. Reject a t older than 5 minutes.

string

Example

t=1761206400,v1=5257a869e7ecebeda32affa62cdca3fa51cad7e77a0e56ff536d0ce8e108d8bd

t=<unix seconds>,v1=<hex HMAC-SHA256>. The MAC covers <t>.<raw body> with the endpoint’s signing secret. During a secret rotation a second v1 carries the previous secret’s MAC. Reject a t older than 5 minutes.

x-inboxcnx-event-id

required

The envelope’s id. Stable across retries: dedupe on it.

string

The envelope’s id. Stable across retries: dedupe on it.

Request Body

Media typeapplication/json

object

id

required

string

>= 1 characters

createdAt

required

string

applicationId

required

string format: uuid

grantId

required

string | null format: uuid

externalUserId

required

string | null

type

required

string

Allowed values: grant.backfill_completed

data

required

object

runId

required

string format: uuid

status

required

string

Allowed values: done cancelled

since

required

string | null

until

required

string

listed

required

integer

published

required

integer

Example

{
  "id": "grant.backfill_completed:9b2f0c4e-6a1d-4f3b-8c55-0d7e2a91b3c4:2026-10",
  "type": "grant.backfill_completed",
  "createdAt": "2026-10-23T08:00:00.000Z",
  "applicationId": "a3c1e8f2-4b7d-4e9a-9f10-6d2b8c5e7a41",
  "grantId": "9b2f0c4e-6a1d-4f3b-8c55-0d7e2a91b3c4",
  "externalUserId": "crm-user-42",
  "data": {
    "runId": "7c1d9e2a-0b3f-4a5c-8d6e-2f1a0b9c8d7e",
    "status": "done",
    "since": "2026-09-20T10:00:00.000Z",
    "until": "2026-10-20T10:00:00.000Z",
    "listed": 2410,
    "published": 1980
  }
}

Responses

2XX

Delivered. The body is ignored.

default

A 408, 429, 5xx, a timeout or a network error is retried with backoff. Any other status, and a redirect (never followed), ends the delivery as failed.