v18

latestOpenAPI 3.0.0raw.githubusercontent.com2024-11-18167108845.6 KB

webhooks

List webhooks

get/webhooks

Response

id_webhook_endpointstring nullable required

The unique UUID of the webhook.

endpoint_descriptionstring nullable required

The description of the webhook.

urlstring nullable required

The endpoint url of the webhook.

secretstring required

The secret of the webhook.

activeboolean nullable required

The status of the webhook.

created_atstring date-time nullable required

The created date of the webhook.

scopestring[] nullable required

The events that the webhook listen to.

id_projectstring nullable required

The project id tied to the webhook.

last_updatestring date-time nullable required

The last update date of the webhook.

Example response

[
  {
    "id_webhook_endpoint": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
    "endpoint_description": "Webhook to receive connection events",
    "url": "https://acme.com/webhook_receiver",
    "secret": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
    "active": true,
    "created_at": "2024-10-01T12:00:00Z",
    "scope": [
      "connection.created"
    ],
    "id_project": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
    "last_update": "2024-10-01T12:00:00Z"
  }
]