openapi: 3.1.0 info: title: Managed Database for PostgreSQL and MySQL Access Control List Webhooks API description: "Managed Database for PostgreSQL and MySQL provides fully-managed relational Database Instances, with MySQL or PostgreSQL as database engines. The resource allows you to focus on development rather than administration or configuration. It comes with a high-availability mode, data replication, and automatic backups.\n\nCompared to traditional database management, which requires customers to provide their infrastructure and resources to manage their databases, Managed Database for PostgreSQL and MySQL Instance offers the user access to Database Instances without setting up the hardware or configuring the software. Scaleway handles the provisioning, manages the configuration, and provides useful features as high availability, automated backup, user management, and more.\n\n\n\n\n## Concepts\n\nRefer to our [dedicated concepts page](https://www.scaleway.com/en/docs/managed-databases-for-postgresql-and-mysql/concepts/) to find definitions of the different terms referring to Managed Database for PostgreSQL and MySQL.\n\n\n\n\n## Quickstart\n\n1. Configure your environment variables.\n \n This is an optional step that seeks to simplify your usage of the APIs.\n \n\n ```bash\n export SCW_ACCESS_KEY=\"\"\n export SCW_SECRET_KEY=\"\"\n export SCW_REGION=\"\"\n ```\n2. Edit the POST request payload you will use to create your Database Instance. Replace the parameters in the following example:\n ```json\n '{\n \"project_id\": \"d8e65f2b-cce9-40b7-80fc-6a2902db6826\",\n \"name\": \"myDB\",\n \"engine\": \"PostgreSQL-15\",\n \"tags\": [\"donnerstag\"],\n \"is_ha_cluster\": true,\n \"node_type\": \"db-pro2-xxs\",\n \"disable_backup\": false,\n \"user_name\": \"my_initial_user\",\n \"password\": \"thiZ_is_v0ry_s3cret\",\n \"volume_type\": \"sbs_5k\",\n \"volume_size\": \"30000000000\"\n }'\n ```\n\n | Parameter | Description |\n | :--------------- |:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n | `project_id` | The ID of the Project you want to create your Database Instance in. To find your Project ID you can **[list the projects](/api/account/project-api/#path-projects-list-all-projects-of-an-organization)** or consult the **[Scaleway console](https://console.scaleway.com/project/settings)**. |\n | `engine` | **REQUIRED** Version ID of the database engine. To check the list of available engines you can use the following endpoint: `https://api.scaleway.com/rdb/v1/regions/$SCW_REGION/database-engines` |\n | `name` | Name of the Database Instance |\n | `node_type` | **REQUIRED** The node type. To check the list of available node types you can use the following endpoint: `https://api.scaleway.com/rdb/v1/regions/$SCW_REGION/node-types` |\n | `is_ha_cluster` | **BOOLEAN** Defines whether High Availability is enabled for the Database Instance |\n | `disable_backup` | **BOOLEAN** Defines whether automated backups are disabled for the Database Instance |\n | `tags` | The list of tags `[\"tag1\", \"tag2\", ...]` that will be associated with the Database Instance. Tags can be appended to the query of the [List Database Instances](#path-database-instances-list-database-instances) call to show results for only the Database Instances using a specific tag. You can also combine tags to list Database Instances that possess all the appended tags. |\n | `user_name` | **REQUIRED** Identifier of the default user, which is created concurrently with the Database Instance |\n | `password` | **REQUIRED** Password for the default user |\n | `volume_type` | Type of volume where data is stored. You can specify either local volume (`lssd`) or block volume (`bssd`, `sbs_5k` or `sbs_15k`). The default value is `lssd` |\n | `volume_size` | Volume size when volume_type is `bssd`, `sbs_5k` or `sbs_15k`. The value should be expressed in bytes. For example 30GB is expressed as 30000000000 |\n3. Create a Database Instance by running the following command. Make sure you include the payload you edited in the previous step.\n ```bash\n curl -X POST \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n \"Content-Type: application/json\" \\\n https://api.scaleway.com/rdb/v1/regions/$SCW_REGION/instances \\\n -d '{\n \"project_id\": \"d8e65f2b-cce9-40b7-80fc-6a2902db6826\",\n \"name\": \"myDB\",\n \"engine\": \"PostgreSQL-15\",\n \"tags\": [\"donnerstag\"],\n \"is_ha_cluster\": true,\n \"node_type\": \"db-pro2-xxs\",\n \"disable_backup\": false,\n \"user_name\": \"my_initial_user\",\n \"password\": \"thiZ_is_v0ry_s3cret\",\n \"volume_type\": \"sbs_5k\",\n \"volume_size\": \"30000000000\"\n }'\n ```\n4. List your Database Instances.\n ```bash\n curl -X GET \\\n -H \"Content-Type: application/json\" \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" https://api.scaleway.com/rdb/v1/regions/$SCW_REGION/instances\n ```\n\n You should get a response like the following:\n\n \n This is a response example, the UUIDs and IP address displayed are not real.\n \n\n ```json\n {\n \"id\": \"f5122f66-fb50-4cef-aa02-487ef4fc1af0\",\n \"name\": \"myDB\",\n \"organization_id\": \"895693aa-3915-4896-8761-c2923b008be7\",\n \"project_id\": \"d8e65f2b-cce9-40b7-80fc-6a2902db6826\",\n \"status\": \"ready\",\n \"engine\": \"PostgreSQL-15\",\n \"endpoint\": {\n \"ip\": \"198.51.100.0\",\n \"port\": 22245,\n \"name\": null\n },\n \"tags\": [\n \"donnerstag\"\n ],\n \"settings\": [],\n \"backup_schedule\": {\n \"frequency\": 24,\n \"retention\": 7,\n \"disabled\": true\n },\n \"is_ha_cluster\": true,\n \"read_replicas\": [],\n \"node_type\": \"db-pro2-xxs\",\n \"volume\": {\n \"type\": \"sbs_5k\",\n \"size\": 30000000000\n }\n \"created_at\": \"2019-04-19T16:24:52.591417Z\",\n \"region\": \"fr-par\"\n }\n ```\n5. Retrieve your Database Instance IP and port from the response.\n \n In the example above, the IP and port are `198.51.100.0` and `22245`, respectively.\n \n6. Connect to your Database Instance with the database client of the engine you selected.\n For MySQL, run the following command:\n ```bash\n mysql -h --port -p -u \n ```\n\n For PostgreSQL, run:\n ```bash\n psql -h -p -U -d rdb\n ```\n\n For the recurring example, the command would look like:\n\n ```bash\n psql -h 198.51.100.0 -p 22245 -U my_initial_user -d rdb\n ```\n7. Enter the database password that you defined upon creation.\n\nYou are now connected to your Managed Database.\n\n\n\nTo perform the following steps, you must first ensure that:\n - you have an account and are logged into the [Scaleway console](https://console.scaleway.com/organization)\n - you have created an [API key](https://www.scaleway.com/en/docs/iam/how-to/create-api-keys/) and that the API key has sufficient [IAM permissions](https://www.scaleway.com/en/docs/iam/reference-content/permission-sets/) to perform the actions described on this page.\n - you have [installed `curl`](https://curl.se/download.html)\n\n\n\n## Technical Information\n\n### Regions\n\nScaleway's infrastructure is spread across different [regions and Availability Zones](https://www.scaleway.com/en/docs/account/reference-content/products-availability/).\n\nManaged Database for PostgreSQL and MySQL is available in the Paris, Amsterdam and Warsaw regions, which are represented by the following path parameters:\n\n- `fr-par`\n- `nl-ams`\n- `pl-waw`\n\n### PostgreSQL specifications\n\n#### Versions\n\nScaleway Database for PostgreSQL supports PostgreSQL versions 11, 12, 13, 14 and 15.\n\n#### System\n\nDifferent modules are available for installation, including TimescaleDB and PostGIS. Refer to the [Managed Database for PostgreSQL and MySQL FAQ page](https://www.scaleway.com/en/docs/managed-databases-for-postgresql-and-mysql/faq/#which-postgresql-extensions-are-available) for an extensive list of PostgreSQL extensions.\n\n#### Database Management\n\nYou can create logical databases through the Scaleway console, the Scaleway APIs or SQL.\n\n- databases created using the Scaleway console or the API are owned by an internal system user. These are called \"managed databases\".\n- databases created using SQL will be owned by the creator. These are called \"unmanaged databases\".\n\n### MySQL specifications\n\n#### Versions\n\nScaleway Database for MySQL supports MySQL 8.\n\n#### System\n\n- only the [InnoDB engine](https://dev.mysql.com/doc/refman/8.0/en/innodb-storage-engine.html) is supported\n- the [Global Transaction Identifier (GTID)](https://dev.mysql.com/doc/refman/8.0/en/replication-gtids-concepts.html) is enabled.\n- [`mysql_native_password`](https://dev.mysql.com/doc/refman/8.0/en/native-pluggable-authentication.html) (default) and [`caching_sha2_password`](https://dev.mysql.com/doc/refman/8.0/en/caching-sha2-pluggable-authentication.html) authentication are supported.\n\n#### User Management\n\n- users with an `admin` role have access to all logical databases and can create new ones.\n- users created via the API are authenticated using the default authentication plugin, which can be changed in the settings.\n\n## Technical Limitations\n\n### PostgreSQL\n\n#### User Management\n\n- users with an `admin` role have `CREATEROLE` and `CREATEDB` privileges.\n- users do NOT have `SUPERUSER` nor `REPLICATION` privileges.\n- permission management through the Scaleway console or API is only possible for the \"managed databases\".\n\n#### Backup and restoration\n\nDatabases that have been backed up and then restored retain the user permission settings in use at the time of backup. If you delete users after backup and then restore your backup in the same database, or if you restore a backup to a different database with different or no users, the permissions configured for them continue to exist, but with no associated owner. This error will put a stop to the restoration process.\n\nTo avoid this issue, we recommend you re-create the users you deleted. In the occasion you restore the backup to a new database, you must create new users with the same names.\n\n## Going Further\n\nFor more information about Managed Database for PostgreSQL and MySQL, you can check out the following pages:\n\n* [Managed Database for PostgreSQL and MySQL Documentation](https://www.scaleway.com/en/docs/managed-databases/postgresql-and-mysql/)\n* [Managed Database for PostgreSQL and MySQL FAQ](https://www.scaleway.com/en/docs/managed-databases-for-postgresql-and-mysql/faq/)\n* [Scaleway Slack Community](https://scaleway-community.slack.com/) join the #database channel\n* [Contact our support team](https://console.scaleway.com/support/tickets)\n\n### How to migrate a database\n\nIf you wish to migrate existing databases to a Managed Database for PostgreSQL or MySQL, you can refer to the [Migrating existing databases to a Database Instance](https://www.scaleway.com/en/docs/tutorials/migrate-databases-instance/) tutorial page.\n\n### Troubleshoooting\n\n#### Disk full status\n\nIf your Database Instance uses local storage, your local volume might eventually approach full capacity and shift to `disk_full` mode. This mode grants you enough space to either [upgrade your node type](https://www.scaleway.com/en/docs/managed-databases-for-postgresql-and-mysql/how-to/upgrade-version/#how-to-change-the-node-type) or [clear out space in your volume](https://www.scaleway.com/en/docs/managed-databases-for-postgresql-and-mysql/troubleshooting/disk-full/)." version: v1 servers: - url: https://api.scaleway.com tags: - name: Webhooks description: '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 page](https://www.scaleway.com/fr/betas/#email-webhooks). ' paths: /transactional-email/v1alpha1/regions/{region}/webhooks: get: tags: - Webhooks operationId: ListWebhooks summary: List Webhooks description: Retrieve Webhooks in a specific Project or in a specific Organization using the `region` parameter. parameters: - in: path name: region description: The region you want to target required: true schema: type: string enum: - fr-par - in: query name: order_by description: (Optional) List Webhooks corresponding to specific criteria. schema: type: string enum: - created_at_desc - created_at_asc default: created_at_desc - in: query name: page description: (Optional) Requested page number. Value must be greater or equal to 1. schema: type: integer format: int32 - in: query name: page_size description: (Optional) Requested page size. Value must be between 1 and 100. schema: type: integer format: uint32 - in: query name: project_id description: (Optional) ID of the Project for which to list the Webhooks. (UUID format) schema: type: string example: 6170692e-7363-616c-6577-61792e636f6d - in: query name: organization_id description: (Optional) ID of the Organization for which to list the Webhooks. (UUID format) schema: type: string example: 6170692e-7363-616c-6577-61792e636f6d - in: query name: domain_id description: (Optional) ID of the Domain for which to list the Webhooks. (UUID format) schema: type: string example: 6170692e-7363-616c-6577-61792e636f6d responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/scaleway.transactional_email.v1alpha1.ListWebhooksResponse' security: - scaleway: [] x-codeSamples: - lang: cURL source: "curl -X GET \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n \"https://api.scaleway.com/transactional-email/v1alpha1/regions/{region}/webhooks\"" - lang: HTTPie source: "http GET \"https://api.scaleway.com/transactional-email/v1alpha1/regions/{region}/webhooks\" \\\n X-Auth-Token:$SCW_SECRET_KEY" post: tags: - Webhooks operationId: CreateWebhook summary: Create a Webhook description: Create a new Webhook triggered by a list of event types and pushed to a Scaleway SNS ARN. parameters: - in: path name: region description: The region you want to target required: true schema: type: string enum: - fr-par responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/scaleway.transactional_email.v1alpha1.Webhook' requestBody: required: true content: application/json: schema: type: object properties: domain_id: type: string description: ID of the Domain to watch for triggering events. (UUID format) example: 6170692e-7363-616c-6577-61792e636f6d project_id: type: string description: ID of the project to which the Webhook belongs. (UUID format) example: 6170692e-7363-616c-6577-61792e636f6d name: type: string description: Name of the Webhook. event_types: type: array description: List of event types that will trigger an event. items: $ref: '#/components/schemas/scaleway.transactional_email.v1alpha1.WebhookEvent.Type' sns_arn: type: string description: Scaleway SNS ARN topic to push the events to. x-properties-order: - domain_id - project_id - name - event_types - sns_arn security: - scaleway: [] x-codeSamples: - lang: cURL source: "curl -X POST \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"domain_id\": \"6170692e-7363-616c-6577-61792e636f6d\",\n \"name\": \"string\",\n \"project_id\": \"6170692e-7363-616c-6577-61792e636f6d\",\n \"sns_arn\": \"string\"\n }' \\\n \"https://api.scaleway.com/transactional-email/v1alpha1/regions/{region}/webhooks\"" - lang: HTTPie source: "http POST \"https://api.scaleway.com/transactional-email/v1alpha1/regions/{region}/webhooks\" \\\n X-Auth-Token:$SCW_SECRET_KEY \\\n domain_id=\"6170692e-7363-616c-6577-61792e636f6d\" \\\n name=\"string\" \\\n project_id=\"6170692e-7363-616c-6577-61792e636f6d\" \\\n sns_arn=\"string\"" /transactional-email/v1alpha1/regions/{region}/webhooks/{webhook_id}: get: tags: - Webhooks operationId: GetWebhook summary: Get information about a Webhook description: Retrieve information about a specific Webhook using the `webhook_id` and `region` parameters. parameters: - in: path name: region description: The region you want to target required: true schema: type: string enum: - fr-par - in: path name: webhook_id description: ID of the Webhook to check. (UUID format) required: true schema: type: string example: 6170692e-7363-616c-6577-61792e636f6d responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/scaleway.transactional_email.v1alpha1.Webhook' security: - scaleway: [] x-codeSamples: - lang: cURL source: "curl -X GET \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n \"https://api.scaleway.com/transactional-email/v1alpha1/regions/{region}/webhooks/{webhook_id}\"" - lang: HTTPie source: "http GET \"https://api.scaleway.com/transactional-email/v1alpha1/regions/{region}/webhooks/{webhook_id}\" \\\n X-Auth-Token:$SCW_SECRET_KEY" patch: tags: - Webhooks operationId: UpdateWebhook summary: Update a Webhook description: Update a Webhook events type, SNS ARN or name. parameters: - in: path name: region description: The region you want to target required: true schema: type: string enum: - fr-par - in: path name: webhook_id description: ID of the Webhook to update. (UUID format) required: true schema: type: string example: 6170692e-7363-616c-6577-61792e636f6d responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/scaleway.transactional_email.v1alpha1.Webhook' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: Name of the Webhook to update. nullable: true event_types: type: array description: List of event types to update. items: $ref: '#/components/schemas/scaleway.transactional_email.v1alpha1.WebhookEvent.Type' sns_arn: type: string description: Scaleway SNS ARN topic to update. nullable: true x-properties-order: - name - event_types - sns_arn security: - scaleway: [] x-codeSamples: - lang: cURL source: "curl -X PATCH \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{}' \\\n \"https://api.scaleway.com/transactional-email/v1alpha1/regions/{region}/webhooks/{webhook_id}\"" - lang: HTTPie source: "http PATCH \"https://api.scaleway.com/transactional-email/v1alpha1/regions/{region}/webhooks/{webhook_id}\" \\\n X-Auth-Token:$SCW_SECRET_KEY" delete: tags: - Webhooks operationId: DeleteWebhook summary: Delete a Webhook description: You must specify the Webhook you want to delete by the `region` and `webhook_id`. Deleting a Webhook is permanent and cannot be undone. parameters: - in: path name: region description: The region you want to target required: true schema: type: string enum: - fr-par - in: path name: webhook_id description: ID of the Webhook to delete. (UUID format) required: true schema: type: string example: 6170692e-7363-616c-6577-61792e636f6d responses: '204': description: '' security: - scaleway: [] x-codeSamples: - lang: cURL source: "curl -X DELETE \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n \"https://api.scaleway.com/transactional-email/v1alpha1/regions/{region}/webhooks/{webhook_id}\"" - lang: HTTPie source: "http DELETE \"https://api.scaleway.com/transactional-email/v1alpha1/regions/{region}/webhooks/{webhook_id}\" \\\n X-Auth-Token:$SCW_SECRET_KEY" /transactional-email/v1alpha1/regions/{region}/webhooks/{webhook_id}/events: get: tags: - Webhooks operationId: ListWebhookEvents summary: List Webhook triggered events description: Retrieve the list of Webhook events triggered from a specific Webhook or for a specific Project or Organization. You must specify the `region`. parameters: - in: path name: region description: The region you want to target required: true schema: type: string enum: - fr-par - in: path name: webhook_id description: ID of the Webhook linked to the events. (UUID format) required: true schema: type: string example: 6170692e-7363-616c-6577-61792e636f6d - in: query name: order_by description: (Optional) List Webhook events corresponding to specific criteria. schema: type: string enum: - created_at_desc - created_at_asc default: created_at_desc - in: query name: page description: Requested page number. Value must be greater or equal to 1. schema: type: integer format: int32 - in: query name: page_size description: Requested page size. Value must be between 1 and 100. schema: type: integer format: uint32 - in: query name: email_id description: ID of the email linked to the events. (UUID format) schema: type: string example: 6170692e-7363-616c-6577-61792e636f6d - in: query name: event_types description: List of event types linked to the events. schema: type: array items: $ref: '#/components/schemas/scaleway.transactional_email.v1alpha1.WebhookEvent.Type' - in: query name: statuses description: List of event statuses. schema: type: array items: $ref: '#/components/schemas/scaleway.transactional_email.v1alpha1.WebhookEvent.Status' - in: query name: project_id description: ID of the webhook Project. (UUID format) schema: type: string example: 6170692e-7363-616c-6577-61792e636f6d - in: query name: organization_id description: ID of the webhook Organization. (UUID format) schema: type: string example: 6170692e-7363-616c-6577-61792e636f6d - in: query name: domain_id description: ID of the domain to watch for triggering events. (UUID format) schema: type: string example: 6170692e-7363-616c-6577-61792e636f6d responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/scaleway.transactional_email.v1alpha1.ListWebhookEventsResponse' security: - scaleway: [] x-codeSamples: - lang: cURL source: "curl -X GET \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n \"https://api.scaleway.com/transactional-email/v1alpha1/regions/{region}/webhooks/{webhook_id}/events\"" - lang: HTTPie source: "http GET \"https://api.scaleway.com/transactional-email/v1alpha1/regions/{region}/webhooks/{webhook_id}/events\" \\\n X-Auth-Token:$SCW_SECRET_KEY" components: schemas: scaleway.transactional_email.v1alpha1.WebhookEvent: type: object properties: id: type: string description: ID of the Webhook Event. webhook_id: type: string description: ID of the Webhook that triggers the Event. organization_id: type: string description: ID of the Webhook Event Organization. project_id: type: string description: ID of the Webhook Event Project. domain_id: type: string description: ID of the webhook event domain. type: type: string description: Type of the Webhook Event. enum: - unknown_type - email_queued - email_dropped - email_deferred - email_delivered - email_spam - email_mailbox_not_found - email_blocklisted - blocklist_created x-enum-descriptions: values: unknown_type: If unspecified, the type of the Webhook Event is unknown by default email_queued: The email was received and is in preparation to be sent to the recipient servers email_dropped: The email was sent but hard-bounced by the recipient server email_deferred: The email was sent but soft-bounced by the recipient server. In this case, the sending of the email will be automatically retried email_delivered: The email was successfully sent email_spam: The email resource was identified as spam by Scaleway or by the recipient server email_mailbox_not_found: The email hard-bounced with a "mailbox not found" error email_blocklisted: The email was blocked before it was sent, as the recipient matches a blocklist blocklist_created: A new blocklist is created default: unknown_type status: type: string description: Status of the Webhook Event. enum: - unknown_status - sending - sent - failed x-enum-descriptions: values: unknown_status: If unspecified, the status of the Webhook event is unknown by default sending: The Webhook event is being sent sent: The Webhook event was sent failed: The Webhook event cannot be sent after multiple retries default: unknown_status data: type: string description: Data sent to the Webhook destination. created_at: type: string description: Date and time of the Webhook Event creation. (RFC 3339 format) format: date-time example: '2022-03-22T12:34:56.123456Z' nullable: true updated_at: type: string description: Date and time of last Webhook Event updates. (RFC 3339 format) format: date-time example: '2022-03-22T12:34:56.123456Z' nullable: true email_id: type: string description: Optional Email ID if the event is triggered by an Email resource. nullable: true x-properties-order: - id - webhook_id - organization_id - project_id - domain_id - type - status - data - created_at - updated_at - email_id scaleway.transactional_email.v1alpha1.Webhook: type: object properties: id: type: string description: ID of the Webhook. domain_id: type: string description: ID of the Domain to watch for triggering events. organization_id: type: string description: ID of the Webhook Organization. project_id: type: string description: ID of the Webhook Project. name: type: string description: Name of the Webhook. event_types: type: array description: List of event types that will trigger a Webhook Event. items: $ref: '#/components/schemas/scaleway.transactional_email.v1alpha1.WebhookEvent.Type' sns_arn: type: string description: Scaleway SNS ARN topic to push the events to. created_at: type: string description: Date and time of the Webhook creation. (RFC 3339 format) format: date-time example: '2022-03-22T12:34:56.123456Z' nullable: true updated_at: type: string description: Date and time of last Webhook updates. (RFC 3339 format) format: date-time example: '2022-03-22T12:34:56.123456Z' nullable: true x-properties-order: - id - domain_id - organization_id - project_id - name - event_types - sns_arn - created_at - updated_at scaleway.transactional_email.v1alpha1.ListWebhooksResponse: type: object properties: total_count: type: integer description: Number of Webhooks matching the requested criteria. format: uint64 webhooks: type: array description: Single page of Webhooks matching the requested criteria. items: $ref: '#/components/schemas/scaleway.transactional_email.v1alpha1.Webhook' x-properties-order: - total_count - webhooks scaleway.transactional_email.v1alpha1.ListWebhookEventsResponse: type: object properties: total_count: type: integer description: Number of Webhook events matching the requested criteria. format: uint64 webhook_events: type: array description: Single page of Webhook events matching the requested criteria. items: $ref: '#/components/schemas/scaleway.transactional_email.v1alpha1.WebhookEvent' x-properties-order: - total_count - webhook_events scaleway.transactional_email.v1alpha1.WebhookEvent.Type: type: string enum: - unknown_type - email_queued - email_dropped - email_deferred - email_delivered - email_spam - email_mailbox_not_found - email_blocklisted - blocklist_created x-enum-descriptions: values: unknown_type: If unspecified, the type of the Webhook Event is unknown by default email_queued: The email was received and is in preparation to be sent to the recipient servers email_dropped: The email was sent but hard-bounced by the recipient server email_deferred: The email was sent but soft-bounced by the recipient server. In this case, the sending of the email will be automatically retried email_delivered: The email was successfully sent email_spam: The email resource was identified as spam by Scaleway or by the recipient server email_mailbox_not_found: The email hard-bounced with a "mailbox not found" error email_blocklisted: The email was blocked before it was sent, as the recipient matches a blocklist blocklist_created: A new blocklist is created default: unknown_type scaleway.transactional_email.v1alpha1.WebhookEvent.Status: type: string enum: - unknown_status - sending - sent - failed x-enum-descriptions: values: unknown_status: If unspecified, the status of the Webhook event is unknown by default sending: The Webhook event is being sent sent: The Webhook event was sent failed: The Webhook event cannot be sent after multiple retries default: unknown_status securitySchemes: scaleway: in: header name: X-Auth-Token type: apiKey