Banner
Events linked to banners - Abyssale Webhooks
A new banner has been generated. It can be filtered by template.
When a banner is generated synchronously from an API call, this event won't be triggered.
{
"id": "a14e1d26-ff41-47cb-bbf9-8f2d777a5bd7",
"file":
{
"type": "jpeg",
"url": "url/name.jpeg",
"cdn_url": "cdn_url/name.jpeg",
"filename": "name.jpeg"
},
"format":
{
"id": "300x250-medium-rectangle",
"width": 300,
"height": 250
},
"template":
{
"id": "873608a1-e498-47dd-a36d-bd065e3e2b8e",
"name": "Template name",
"created_at": 1623229458,
"updated_at": 1623229457
}
}
id: Banner's id, UUID v4 format.file.type: The banner format it cant be jpeg/png/pdf.file.url: URL where the image is stored.file.cdn_url: The CDN URL where the image is stored (not available for zip files). That URL is designed for high-speed & low-latency performance. A limited bandwidth applies to all plans (see the pricing table).file.filename: Name of the file. If the related template contains a custom naming scheme, the custom name will be available from this property.format.id: The format's name as you defined it in the template.format.width: The format width in pixels.format.height: The format height in pixels.template.id: Template's id, UUID v4 format.template.name: The template name as you defined it in the application.template.created_at: Template creation date, timestamp format.template.updated_at: Template updated date, timestamp format.
It can be filtered by template.
{
"id": "c18c3cec-14c2-4539-99d4-92623b6a4aef",
"banners":
[
{
"id": "ec3a9fcd-f209-4077-b5ea-037d4bdfa9f2",
"file":
{
"type": "jpeg",
"url": "url/name.jpeg",
"cdn_url": "cdn_url/name.jpeg",
"filename": "name.jpeg"
},
"format":
{
"id": "facebook",
"width": 1200,
"height": 628
},
"template":
{
"id": "834362df-966b-46fb-a92b-213f3c2ceeac",
"name": "Template name",
"created_at": 1649682431,
"updated_at": 1649682494
}
}
],
"errors":[
{
template_format_name: "(Placeholder Format, will be the real value)",
reason: "Element text_placeholder error: The text 'Placeholder text' cannot fit within the defined space.",
}
]
}
id: The generation request id you received when calling the API, UUID v4 format.banners: A list of banners created. Banner properties are the same as the one you can find in NEW_BANNER.errors: A list of errors, if it didn't work during the generation.
Last modified 1mo ago