List webhook deliveries

Lists deliveries to an endpoint, filterable by state. Each carries the event envelope it sends and every attempt made: timestamp, status code, duration, error, and the beginning of your response, which is usually what explains a rejection. body is null for a v1 endpoint — its legacy body is built from the message at send time, not stored — and for a delivery nothing was sent for.

GET/webhook-endpoints/{endpoint_id}/deliveries

Authorization

AuthorizationBearer token (API key) · headerrequired

Pass an AI Inbx API key as a Bearer token.

Path parameters

endpoint_idstringrequired

The prefixed webhook endpoint ID.

matches ^[a-z]+_[0-9a-f]{32}$

Query parameters

limitinteger

Maximum number of resources to return.

min 1 · max 100 · default: 40

cursorstring

Opaque cursor from the previous page.

min length 1

spacestring

Only resources in this space. Pass `none` for resources that belong to the workspace itself (`space_id: null`), or omit for the workspace and all its spaces.

matches ^(?:none|spc_[0-9a-f]{32})$

statestring

Filter by delivery state.

Allowed:pendingdeliveredfailed

Responses

200Success.

dataobject[]required

Show properties

Array of object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

event_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

event_typestringrequired

Allowed:email.receivedemail.sentemail.deliveredemail.bouncedemail.complainedemail.failedemail.unsubscribedemail.openedemail.clickedthread.createddomain.verifieddomain.lostmailbox.connectedmailbox.needs_reauthmailbox.disconnected

resource_idstringrequired

statestringrequired

Allowed:pendingdeliveredfailed

next_attempt_atstring<date-time> | anyrequired

Show properties

Any of:

string<date-time>

string<date-time>

any

any

created_atstring<date-time>required

matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

bodyobject | anyrequired

The event envelope the endpoint receives. Null for a `v1` endpoint in a listing — its legacy body is built from the message when it is sent and is not stored — and for a delivery nothing was sent for: a `v1` endpoint's event whose subject no longer exists is settled as failed with no attempts.

Show properties

Any of:

object

Any of:

object

One of:

object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

space_idstring | anyrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

any

any

dataobjectrequired

Show properties

email_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

thread_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

domain_idstring | anyrequired

Show properties

Any of:

string

string

any

any

mailbox_idstring | anyrequired

Show properties

Any of:

string

string

any

any

fromstring<email>required

matches ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

tostring<email>[]required

subjectstringrequired

snippetstringrequired

attachmentsobject[]

Show properties

Array of object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

filenamestringrequired

content_typestringrequired

sizeintegerrequired

min 0 · max 9007199254740991

preparationstringrequired

Allowed:readypartialunsupportedfailed

categorystring | anyrequired

Show properties

Any of:

string

string

any

any

verdictsobject

What the receiving side thought of the message, when it said.

Show properties

spamstring

spfstring

dkimstring

dmarcstring

object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

space_idstring | anyrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

any

any

dataobjectrequired

Show properties

email_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

thread_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

domain_idstring | anyrequired

Show properties

Any of:

string

string

any

any

mailbox_idstring | anyrequired

Show properties

Any of:

string

string

any

any

fromstring<email>required

matches ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

tostring<email>[]required

subjectstringrequired

snippetstringrequired

attachmentsobject[]

Show properties

Array of object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

filenamestringrequired

content_typestringrequired

sizeintegerrequired

min 0 · max 9007199254740991

preparationstringrequired

Allowed:readypartialunsupportedfailed

suppression_keystring | anyrequired

Show properties

Any of:

string

string

any

any

object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

space_idstring | anyrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

any

any

dataobjectrequired

Show properties

email_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

thread_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

domain_idstring | anyrequired

Show properties

Any of:

string

string

any

any

mailbox_idstring | anyrequired

Show properties

Any of:

string

string

any

any

suppression_keystring | anyrequired

Show properties

Any of:

string

string

any

any

recipientsstring<email>[]required

object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

space_idstring | anyrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

any

any

dataobjectrequired

Show properties

email_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

thread_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

domain_idstring | anyrequired

Show properties

Any of:

string

string

any

any

mailbox_idstring | anyrequired

Show properties

Any of:

string

string

any

any

suppression_keystring | anyrequired

Show properties

Any of:

string

string

any

any

recipientsstring<email>[]required

permanentbooleanrequired

reasonstringrequired

object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

space_idstring | anyrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

any

any

dataobjectrequired

Show properties

email_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

thread_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

domain_idstring | anyrequired

Show properties

Any of:

string

string

any

any

mailbox_idstring | anyrequired

Show properties

Any of:

string

string

any

any

suppression_keystring | anyrequired

Show properties

Any of:

string

string

any

any

recipientsstring<email>[]required

reasonstring | anyrequired

Show properties

Any of:

string

string

any

any

object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

space_idstring | anyrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

any

any

dataobjectrequired

Show properties

email_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

thread_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

domain_idstring | anyrequired

Show properties

Any of:

string

string

any

any

mailbox_idstring | anyrequired

Show properties

Any of:

string

string

any

any

suppression_keystring | anyrequired

Show properties

Any of:

string

string

any

any

reasonstringrequired

What the provider said: why the message never went out.

object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

space_idstring | anyrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

any

any

dataobjectrequired

Show properties

email_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

domain_idstring | anyrequired

Show properties

Any of:

string

string

any

any

mailbox_idstring | anyrequired

Show properties

Any of:

string

string

any

any

addressstring<email>required

matches ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

keystringrequired

scopestringrequired

Allowed:alloptional

sourcestringrequired

Allowed:linkone_clickreply

object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

space_idstring | anyrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

any

any

dataobjectrequired

Show properties

email_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

thread_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

domain_idstring | anyrequired

Show properties

Any of:

string

string

any

any

mailbox_idstring | anyrequired

Show properties

Any of:

string

string

any

any

suppression_keystring | anyrequired

Show properties

Any of:

string

string

any

any

user_agentstring | anyrequired

Show properties

Any of:

string

string

any

any

object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

space_idstring | anyrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

any

any

dataobjectrequired

Show properties

email_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

thread_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

domain_idstring | anyrequired

Show properties

Any of:

string

string

any

any

mailbox_idstring | anyrequired

Show properties

Any of:

string

string

any

any

suppression_keystring | anyrequired

Show properties

Any of:

string

string

any

any

urlstring<uri>required

object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

space_idstring | anyrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

any

any

dataobjectrequired

Show properties

thread_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

subjectstringrequired

mailboxstring<email>required

matches ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

forward_ofstring | anyrequired

Set when a forward opened the thread: the conversation it carries.

Show properties

Any of:

string

string

any

any

object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

space_idstring | anyrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

any

any

dataobjectrequired

Show properties

domain_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

namestringrequired

regionstringrequired

Allowed:eu-central-1us-east-1

object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

space_idstring | anyrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

any

any

dataobjectrequired

Show properties

domain_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

namestringrequired

regionstringrequired

Allowed:eu-central-1us-east-1

object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

space_idstring | anyrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

any

any

dataobjectrequired

Show properties

mailbox_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

addressstring<email>required

matches ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

providerstringrequired

Allowed:googlemicrosoft

app_idstring | anyrequired

Show properties

Any of:

string

string

any

any

refstring | anyrequired

The `ref` the connect link was made with.

Show properties

Any of:

string

string

any

any

reconnectedbooleanrequired

object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

space_idstring | anyrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

any

any

dataobjectrequired

Show properties

mailbox_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

addressstring<email>required

matches ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

providerstringrequired

Allowed:googlemicrosoft

reasonstring | anyrequired

Show properties

Any of:

string

string

any

any

object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

space_idstring | anyrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

any

any

dataobjectrequired

Show properties

mailbox_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

addressstring<email>required

matches ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

providerstringrequired

Allowed:googlemicrosoft

reasonstring | anyrequired

Show properties

Any of:

string

string

any

any

object

object

any

any

attemptsobject[]required

Show properties

Array of object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

attempted_atstring<date-time>required

status_codeinteger | anyrequired

Show properties

Any of:

integer

integer

any

any

duration_msintegerrequired

min 0 · max 9007199254740991

errorstring | anyrequired

Show properties

Any of:

string

string

any

any

responsestring | anyrequired

Show properties

Any of:

string

string

any

any

next_cursorstring | anyrequired

Show properties

Any of:

string

string

any

any

400The request is invalid.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

401The API key is missing or invalid.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

403The API key does not have the required scope.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

404The requested resource does not exist.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

409The request conflicts with the resource's current state.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

413The request body or attachments are too large.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

415The request body is not JSON.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

422The request body failed validation.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

429The organisation's request budget is spent (`too_many_requests`), or an upstream mail provider is throttling (`rate_limited`).

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

500An internal error occurred.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

502An upstream mail provider failed.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

503The service is temporarily unavailable.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

Request

curl -X GET "https://api.aiinbx.com/api/v2/webhook-endpoints/string/deliveries" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.aiinbx.com/api/v2/webhook-endpoints/string/deliveries", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.aiinbx.com/api/v2/webhook-endpoints/string/deliveries",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "data": [
    {
      "id": "string",
      "event_id": "string",
      "event_type": "email.received",
      "resource_id": "string",
      "state": "pending",
      "next_attempt_at": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "body": {
        "id": "string",
        "type": "email.received",
        "created_at": "2019-08-24T14:15:22Z",
        "space_id": "string",
        "data": {
          "email_id": "string",
          "thread_id": "string",
          "domain_id": "string",
          "mailbox_id": "string",
          "from": "user@example.com",
          "to": [
            "user@example.com"
          ],
          "subject": "string",
          "snippet": "string",
          "attachments": [
            {
              "id": "string",
              "filename": "string",
              "content_type": "string",
              "size": 9007199254740991,
              "preparation": "ready"
            }
          ],
          "category": "human",
          "verdicts": {
            "spam": "string",
            "spf": "string",
            "dkim": "string",
            "dmarc": "string"
          }
        }
      },
      "attempts": [
        {
          "id": "string",
          "attempted_at": "2019-08-24T14:15:22Z",
          "status_code": -9007199254740991,
          "duration_ms": 9007199254740991,
          "error": "string",
          "response": "string"
        }
      ]
    }
  ],
  "next_cursor": "string"
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}