Webhook integration
Learn how to configure a Webhook integration with Pushwoosh to receive real-time data on email status events.
Integration overview
This integration allows you to set up a Webhook endpoint to receive real-time data from Pushwoosh, specifically Email status events, such as Email Sent, Email Delivered, Email Bounced, Email Opened, etc.
Type of integration
Source: Data is sent from Pushwoosh to your system via the webhook.
Glossary
Webhook endpoint: A server-side URL that receives HTTP POST requests from Pushwoosh. Clients can specify the exact port.
Example without port: https://clientdomainname.com/webhook_endpoint
Example with the port specified: https://clientdomainname.com:8081/webhook_endpoint
Synchronized entities
Email status events that provide data about user interactions with the messages you send.
Setting up the integration
To set up the integration:
In your Pushwoosh account, go to Settings > 3rd Party Integrations and find Webhook integration. Click Configure.
In the window that opens, enter the full URL of the webhook endpoint and click Apply.
Once configured successfully, you’ll begin receiving requests from Pushwoosh.
How to verify the integration is working
Once the integration is set up, you’ll receive HTTP POST requests from Pushwoosh at the specified webhook endpoint.
Webhook request body
Field name | Type | Required | Description | Example |
---|---|---|---|---|
event_name | string | Yes | The name of the event | "Email Sent" |
message_id | uint64 | No | The unique ID of the message associated with the event. | 200XXXX3258 |
message_code | string | Yes | The code of the message associated with the event. | "B780-XXXXXX3C-XXXX0375" |
campaign_id | uint64 | No | The unique ID of the campaign associated with the event. | 96XXXX |
platform | string | Yes | The device platform associated with the event (e.g., iOS, Android, Email). | "Email" |
application_code | string | Yes | The code of the application associated with the event. | "3XXXX-XXXX1" |
hwid | string | Yes | The device identifier (HWID) associated with the event. | "example@gmail.com" |
user_id | string | Yes | The Pushwoosh User ID associated with the event. | "15XXXX8" |
payload | string | No | The content related to the message depends on the platform. For Email events, this contains the email subject. For other platforms, this may include different relevant content specific to the event (e.g., message content or title). | "Don't miss our summer sale!" |
timestamp | int64 | Yes | The time when the event occurred, in UNIX timestamp format. | 1723798222 |
journey_title | string | No | The title of the Journey associated with the event. | "Summer sale" |
journey_point_title | string | No | The title of the specific point within the Journey associated with the event. | "5_summer sale_new" |
Request example
Last updated