Sync events allow you to keep your Rejection Safelist and Rejection Denylist synced to your own database or CRM by sending information about additions and removals via webhooks.
Note: Safelists can also be known as whitelists, while denylists can be known as blacklists.
For safelist entries, a webhook will be triggered when an entry is added or removed. For denylist entries, an event will be triggered when an address is added, removed, or changed (ie, if it was already on the rejection denylist before, and gets added back because of a new event). Below is a list of the keys included for sync events.
| Key | description | ||
|---|---|---|---|
| ts | the integer UTC unix timestamp that the event occurred | ||
| type | the list the sync event applies to (safelist or denylist) | ||
| action | the name of the event. Possible values: add (safelist or denylist), remove (safelist or denylist), change (denylist only) | ||
| reject | details of the entry. Contains an array of key/value pairs with the following keys: | ||
| reason | for the rejection denylist only, the reason the email address was added to the rejection denylist | ||
| detail | the (optional) user-generated note about the entry for manually-added denylist entries and all safelist entries | ||
| last_event_at | for the rejection denylist only, the date/time of the last event for this email address (formatted date in YYYY-MM-DD HH:MM:SS) | ||
| the email address impacted by the safelist or denylist entry | |||
| created_at | the date/time that the original entry was created (formatted date in YYYY-MM-DD HH:MM:SS) | ||
| expires_at | for the rejection denylist only, the date/time that the rejection denylist entry expires automatically, if any (formatted date in YYYY-MM-DD HH:MM:SS) | ||
| expired | for the rejection denylist only, whether the rejection denylist entry has expired | ||
| subaccount | for the rejection denylist only, the subaccount, if any, that the rejection entry applies to | ||
| sender | for the rejection denylist only, the sender, if any, that the rejection entry applies to | ||