Waypoint Webhook Event Types

This is the list of event types that we currently send.
For guidance on how to listen to these events, take a look at Svix's guide to consuming webhooks.

EMAIL_MESSAGE.BOUNCED

Event triggered if the email message bounces on attempted delivery.

Example

JSON

{
  "createdAt": "2024-10-10T21:16:25.749Z",
  "emailMessageId": "em_R7kzKeQx7AHbQSCy",
  "id": "log_Hvq9HzAzgzi3gKwV",
  "message": "5.7.1 Delivery not authorized, message refused support@usewaypoint.com",
  "updatedAt": "2024-10-10T21:16:25.749Z"
}

EMAIL_MESSAGE.CLICKED

Event triggered when a link is clicked on the email message.

Example

JSON

{
  "createdAt": "2024-10-10T21:16:25.749Z",
  "emailMessageId": "em_R7kzKeQx7AHbQSCy",
  "id": "log_Hvq9HzAzgzi3gKwV",
  "message": "An email link was clicked by a recipient at IP address 193.95.29.9. User agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:131.0) Gecko/20100101 Firefox/131.0. Link: https://dashboard.usewaypoint.com",
  "updatedAt": "2024-10-10T21:16:25.749Z"
}

EMAIL_MESSAGE.COMPLAINT_FILED

Event triggered if the email message is marked as spam.

Example

JSON

{
  "createdAt": "2024-10-10T21:16:25.749Z",
  "emailMessageId": "em_R7kzKeQx7AHbQSCy",
  "id": "log_Hvq9HzAzgzi3gKwV",
  "message": "Email was marked as abuse by support@usewaypoint.com.",
  "updatedAt": "2024-10-10T21:16:25.749Z"
}

EMAIL_MESSAGE.CONTACT_UNSUBSCRIBED

Event triggered when the recipient unsubscribes (from the unsubscribe link on the email message).

Example

JSON

{
  "createdAt": "2024-10-10T21:16:25.749Z",
  "emailMessageId": "em_R7kzKeQx7AHbQSCy",
  "id": "log_Hvq9HzAzgzi3gKwV",
  "message": "'support@usewaypoint.com' unsubscribed from 'Product updates'",
  "updatedAt": "2024-10-10T21:16:25.749Z"
}

EMAIL_MESSAGE.CREATED

Event triggered when the email message is created on Waypoint.

Example

JSON

{
  "createdAt": "2024-10-10T21:16:25.749Z",
  "emailMessageId": "em_R7kzKeQx7AHbQSCy",
  "id": "log_Hvq9HzAzgzi3gKwV",
  "message": "Email message was created.",
  "updatedAt": "2024-10-10T21:16:25.749Z"
}

EMAIL_MESSAGE.DELIVERED

Event triggered when the email message is successfully delivered.

Example

JSON

{
  "createdAt": "2024-10-10T21:16:25.749Z",
  "emailMessageId": "em_R7kzKeQx7AHbQSCy",
  "id": "log_Hvq9HzAzgzi3gKwV",
  "message": "Email successfully delivered to support@usewaypoint.com. Delivery time: 1 second.",
  "updatedAt": "2024-10-10T21:16:25.749Z"
}

EMAIL_MESSAGE.SENT

Event triggered when the email message is sent by Waypoint.

Example

JSON

{
  "createdAt": "2024-10-10T21:16:25.749Z",
  "emailMessageId": "em_R7kzKeQx7AHbQSCy",
  "id": "log_Hvq9HzAzgzi3gKwV",
  "message": "Email was sent.",
  "updatedAt": "2024-10-10T21:16:25.749Z"
}