The Webhooks resource enables users to set up custom webhooks that are triggered by specific events on our platform. This feature allows users to receive real-time notifications to a specified URL when designated events occur. It enhances integration capabilities, allowing for automated reactions in external systems or applications in response to activities within our platform.
See the Webhooks guide for every event payload and how deliveries work.
Retrieve a list of all webhooks configured for a specific account. This endpoint provides an overview of active webhooks, including their URLs and the events they are set to listen to. It's useful for managing and reviewing webhook configurations.
curl "https://api.flashy.app/webhooks" \
-H "x-api-key: YOUR_API_KEY"Fetch the list of events that webhooks can listen to (such as contact_created,
email_campaign_opened). Use it for planning and setting up new webhooks.
curl "https://api.flashy.app/webhooks/list" \
-H "x-api-key: YOUR_API_KEY"Create a new webhook. Specify the URL where notifications should be sent and the events to monitor. See the Webhooks guide for every payload you will receive.
curl -X POST "https://api.flashy.app/webhook" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"endpoint": "https://mydomain.com/",
"events": [
"contact_created",
"email_campaign_opened"
]
}'Modify the list of events a webhook listens to or change its destination URL.
curl -X PUT "https://api.flashy.app/webhook" \
-H "x-api-key: YOUR_API_KEY"Permanently delete a specified webhook and stop all its event notifications.
curl -X DELETE "https://api.flashy.app/webhook" \
-H "x-api-key: YOUR_API_KEY"