Webhooks

Event Triggers

5min

There are 20 triggers to choose from. These include status updates, category reason updates, contact modifications, and flossing completed. You can see the full list of triggers when you create a new webhook or edit an existing one.

Payload information

In the payload we POST to your webhook URL, you will have an event key with a value in dot notation. For example, a status of undeliverable is sent as "status.undeliverable"

Status triggers

  • Status: Undeliverable - status.undeliverable
  • Status: Unknown - status.unknown
  • Status: Risky - status.risky

Reason triggers

  • Reason: Illegitimate - reason.illegitimate
  • Reason: Bounced - reason.bounced
  • Reason: Invalid - reason.invalid
  • Reason: Blacklisted - reason.blacklisted
  • Reason: Role - reason.role
  • Reason: Complainer - reason.complainer
  • Reason: Spam - reason.spam
  • Reason: Available - reason.available
  • Reason: Banned - reason.banned
  • Reason: Disposable - reason.disposable
  • Reason: Deactivated - reason.deactivated
  • Reason: Nonexistent - reason.nonexistent
  • Reason: Inbox Full - reason.inbox_full
  • Reason: Unverified - reason.unverified
  • Reason: Accept All - reason.accept_all

Contact triggers

  • Contact: Fixed - contact.fixed
  • Contact: Unsubscribed - contact.unsubscribed
  • Contact: Deleted - contact.deleted
  • Contact. Tagged - contact.tagged
  • Contact: Updated - contact.updated

Floss session triggers

  • Flossing Completed - job.finished