Rivier/ Reference/ domains

Domains deliverability event ingest

post/deliverability/events

Report a delivery event (sent, delivered, deferred, bounced, complained, opened, clicked, unsubscribed). Counted per domain, day and recipient provider; hard bounces and complaints suppress the address; repeated soft bounces suppress by the project's rule.

Before you call

Credential
Authorization: Bearer $KEY
Scope
domains:write
Graphql
Mutation.domainsDeliverabilityEventIngest
Sdk
domains.deliverabilityEvent.ingest
Cli
domains deliverability event ingest

Request bodyapplication/json, required

  • domainstringrequired
    At most 253 characters.
  • statestringrequired
    One of: sent, delivered, deferred, bounced, complained, opened, clicked, unsubscribed.
  • transportstringrequired
    At most 40 characters.
  • tostring
    At most 320 characters.
  • codestring
    At most 40 characters.
  • bounceTypestring
    One of: hard, soft.
  • atstring (date-time)
  • refstring
    At most 200 characters.
  • ipstring
    At most 45 characters.

Responses

  • 200application/json
    Success
    • 400application/json
      The request was malformed
      • errorstringrequired
      • messagestring
    • 401application/json
      No valid credential
      • errorstringrequired
      • messagestring
    • 403application/json
      The credential lacks the scope, origin or address
      • errorstringrequired
      • messagestring
    • 429application/json
      Over the key's rate limit; see Retry-After
      • errorstringrequired
      • messagestring

    This page as Markdown