Sign in
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"
  }
]

Changes

Changed in 5 of the 18 revisions of this API.102

  • ca213ae36b7f1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 167edd5346ec1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9d25bd589fe97See the full diff
    • ▲

      the response property items/active became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property items/created_at became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property items/id_project became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property items/id_webhook_endpoint became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property items/scope became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property items/secret became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property items/url became nullable for the status 200

      response-property-became-nullable

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 414c3e999e0b2See the full diff
    • ▲

      the response property items/endpoint_description became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property items/last_update became nullable for the status 200

      response-property-became-nullable

  • f48b82299d9d1See the full diff
    • ○

      endpoint added

      endpoint-added