Get webhook delivery logs for an email

GET 
/v1/email/webhook-logs

Returns the webhook delivery attempts for one email, identified by refId (EmailPayloadId), scoped to the caller's tenant.

Request

Query Parameters

refId stringrequired

Reference ID (EmailPayloadId) of the email

limit integer

Max rows (default 50, max 200)

Responses

200

OK

application/json

Schema

Schema

data

object[]

Array [

accountId integer

attempt integer

createdAt string

event string

eventKey string

httpStatus integer

latencyMs integer

mailerEvent string

method string

outcome string

refId string

requestBody string

requestBytes integer

requestUrl string

query-param values masked

responseError string

responseSnippet string

tenantId string

trigger string

webhookId string

]

success boolean
totalCount integer

Example (from schema)

{
  "data": [
    {
      "accountId": 0,
      "attempt": 0,
      "createdAt": "string",
      "event": "string",
      "eventKey": "string",
      "httpStatus": 0,
      "latencyMs": 0,
      "mailerEvent": "string",
      "method": "string",
      "outcome": "string",
      "refId": "string",
      "requestBody": "string",
      "requestBytes": 0,
      "requestUrl": "string",
      "responseError": "string",
      "responseSnippet": "string",
      "tenantId": "string",
      "trigger": "string",
      "webhookId": "string"
    }
  ],
  "success": true,
  "totalCount": 0
}

400

refId is required / limit is not a number

application/json

Schema

Schema

error string
success boolean

Example (from schema)

{
  "error": "string",
  "success": false
}

401

Unauthorized

application/json

Schema

Schema

error string
success boolean

Example (from schema)

{
  "error": "string",
  "success": false
}

500

Internal Server Error

application/json

Schema

Schema

error string
success boolean

Example (from schema)

{
  "error": "string",
  "success": false
}

Loading...