Invoice emails

Invoice emails

Invoice email webhooks are emitted by the Invoices API when an invoice is sent by email (POST /emails).

Events

Action Event name
send invoice by email (POST /emails) invoiceemail.created

Payload example (invoiceemail.created)

The data field contains the email envelope from the sent message (transport metadata: from, to, etc.).

{
  "providerId": "5f243d100617680712e78dd7",
  "apiKey": "string",
  "data": {
    "from": "noreply@example.com",
    "to": ["recipient@example.com"]
  }
}

Payload fields (invoiceemail.created)

Field Type Description
providerId string Account ID of the provider (24-character hex ObjectId)
apiKey string API key used for the request (X-API-KEY header)
data object Email envelope from the transport (e.g. from, to); shape depends on the mail transport