If you use the Zenvia Customer Cloud API to send messages, it's important to set up a webhook to track the status of sent messages and monitor the messages sent. This article explains how this process works.
Why do messages sent via API not appear on the platform?
Messages sent directly via the API do not appear in the platform interface because querying and monitoring those messages occur outside the platform's environment. To track these sends, you need to set up a webhook in your organization, ensuring that status data is automatically received.
What is a webhook and how does it work?
A webhook is a receiving point where the platform sends real-time notifications whenever there are relevant updates about an event, such as sending, delivery, or reading of a message. With it, you can:
- Monitor the status of API sends.
- Consolidate information into custom reports.
- Automate workflows based on the received data.
How to set up a webhook to monitor messages?
- Create a receiving URL:
- Set up an endpoint in your system to receive notifications sent by the platform. This endpoint should be prepared to process HTTP POST requests.
- Register the webhook on the platform:
- Access the webhook configuration section in the platform.
- Enter the URL created in the previous step.
- Specify the events you want to monitor (such as "message sent", "message delivered", or "message read").
- Validate the operation:
- Perform tests to ensure the webhook is correctly receiving notifications.
- Check the receiving logs in your system to confirm the events.
API Documentation
For more details on how to set up a webhook, refer to the technical documentation on Zenvia APIs - Webhooks.
In this documentation, you will find:
- Code examples to create a webhook.
- Details about available events.
Next steps
- Set up your webhook and ensure it's working correctly.
- Use the received notifications to create custom reports or dashboards.