Webhooks
Webhooks enable real-time communication and automation between systems by sending messages through all protocols supported by SNS, such as HTTP, HTTPS, and Serverless Functions, allowing for immediate updates and actions based on specific events. This feature is in beta. You can request quotas from the Scaleway betas pageOpen in new context.
List Webhooks
Retrieve Webhooks in a specific Project or in a specific Organization using the region parameter.
path Parameters
regionThe region you want to target
query Parameters
order_by(Optional) List Webhooks corresponding to specific criteria.
page(Optional) Requested page number. Value must be greater or equal to 1.
page_size(Optional) Requested page size. Value must be between 1 and 100.
project_id(Optional) ID of the Project for which to list the Webhooks. (UUID format)
organization_id(Optional) ID of the Organization for which to list the Webhooks. (UUID format)
domain_id(Optional) ID of the Domain for which to list the Webhooks. (UUID format)
List Webhooks › Responses
total_countNumber of Webhooks matching the requested criteria.
Single page of Webhooks matching the requested criteria.
Create a Webhook
Create a new Webhook triggered by a list of event types and pushed to a Scaleway SNS ARN.
path Parameters
regionThe region you want to target
Create a Webhook › Request Body
domain_idID of the Domain to watch for triggering events. (UUID format)
project_idID of the project to which the Webhook belongs. (UUID format)
nameName of the Webhook.
List of event types that will trigger an event.
sns_arnScaleway SNS ARN topic to push the events to.
Create a Webhook › Responses
idID of the Webhook.
domain_idID of the Domain to watch for triggering events.
organization_idID of the Webhook Organization.
project_idID of the Webhook Project.
nameName of the Webhook.
List of event types that will trigger a Webhook Event.
sns_arnScaleway SNS ARN topic to push the events to.
created_atDate and time of the Webhook creation. (RFC 3339 format)
updated_atDate and time of last Webhook updates. (RFC 3339 format)
Get information about a Webhook
Retrieve information about a specific Webhook using the webhook_id and region parameters.
path Parameters
regionThe region you want to target
webhook_idID of the Webhook to check. (UUID format)
Get information about a Webhook › Responses
idID of the Webhook.
domain_idID of the Domain to watch for triggering events.
organization_idID of the Webhook Organization.
project_idID of the Webhook Project.
nameName of the Webhook.
List of event types that will trigger a Webhook Event.
sns_arnScaleway SNS ARN topic to push the events to.
created_atDate and time of the Webhook creation. (RFC 3339 format)
updated_atDate and time of last Webhook updates. (RFC 3339 format)
Delete a Webhook
You must specify the Webhook you want to delete by the region and webhook_id. Deleting a Webhook is permanent and cannot be undone.
path Parameters
regionThe region you want to target
webhook_idID of the Webhook to delete. (UUID format)
Delete a Webhook › Responses
Update a Webhook
Update a Webhook events type, SNS ARN or name.
path Parameters
regionThe region you want to target
webhook_idID of the Webhook to update. (UUID format)
Update a Webhook › Request Body
nameName of the Webhook to update.
List of event types to update.
sns_arnScaleway SNS ARN topic to update.
Update a Webhook › Responses
idID of the Webhook.
domain_idID of the Domain to watch for triggering events.
organization_idID of the Webhook Organization.
project_idID of the Webhook Project.
nameName of the Webhook.
List of event types that will trigger a Webhook Event.
sns_arnScaleway SNS ARN topic to push the events to.
created_atDate and time of the Webhook creation. (RFC 3339 format)
updated_atDate and time of last Webhook updates. (RFC 3339 format)
List Webhook triggered events
Retrieve the list of Webhook events triggered from a specific Webhook or for a specific Project or Organization. You must specify the region.
path Parameters
regionThe region you want to target
webhook_idID of the Webhook linked to the events. (UUID format)
query Parameters
order_by(Optional) List Webhook events corresponding to specific criteria.
pageRequested page number. Value must be greater or equal to 1.
page_sizeRequested page size. Value must be between 1 and 100.
email_idID of the email linked to the events. (UUID format)
List of event types linked to the events.
List of event statuses.
project_idID of the webhook Project. (UUID format)
organization_idID of the webhook Organization. (UUID format)
domain_idID of the domain to watch for triggering events. (UUID format)
List Webhook triggered events › Responses
total_countNumber of Webhook events matching the requested criteria.
Single page of Webhook events matching the requested criteria.