Overview — Webhooks
Abyssale sends you notifications when new events happen on your account. Webhooks are a powerful tool for integrating Abyssale into custom workflows, enabling near real-time automation without polling.
What Are Webhooks?
A webhook is an automated way for Abyssale to send data to your application the moment a specific event occurs. When an event you subscribe to takes place (e.g. a new banner is generated), Abyssale sends an HTTP POST request to a URL you define, called the Endpoint, with a JSON payload containing all relevant event data.
Example Use Cases
- Instant Asset Delivery (
NEW_BANNER) — receive the download URL immediately and upload to your CDN or S3 bucket. - Export Completion (
NEW_EXPORT) — download the ZIP and notify your team on Slack. - Workflow Synchronization (
TEMPLATE_STATUS) — notify internal tools when a design is approved or rejected. - Async Batch Completion (
NEW_BANNER_BATCH) — know the exact moment a batch generation job finishes.
Technical Mechanism
| Property | Detail |
|---|---|
| Method | HTTP POST (HTTPS only) |
| Content Type | application/json |
| Endpoint | A public URL on your server |
| Acknowledgement | Return HTTP 200 OK within 15 seconds |
| Retries | Up to 5 attempts in a 3-hour window on failure |
| Static IP Support | Contact support for IP whitelisting ranges |
| Identifying Header | X-Referer: api.abyssale.com |
Getting Started
Configure your webhook endpoint in the Abyssale dashboard: How to Create an Abyssale Webhook
Then review the Events Reference for payload structures.