webhooks

Update webhook status

put/webhooks/{id}

Path parameters

idstring required

id of the webhook to update.

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 12 of the 18 revisions of this API.145

    • removed the success response with the status 200

      response-success-status-removed

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

    • added the success response with the status 200

      response-success-status-added

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

    • removed the success response with the status 200

      response-success-status-removed

    • added the success response with the status 200

      response-success-status-added

    • removed the success response with the status 200

      response-success-status-removed

    • added the success response with the status 200

      response-success-status-added

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

    • removed the success response with the status 200

      response-success-status-removed

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

    • 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

    • 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

    • the response property active became nullable for the status 201

      response-property-became-nullable

    • the response property created_at became nullable for the status 201

      response-property-became-nullable

    • the response property id_project became nullable for the status 201

      response-property-became-nullable

    • the response property id_webhook_endpoint became nullable for the status 201

      response-property-became-nullable

    • the response property scope became nullable for the status 201

      response-property-became-nullable

    • the response property secret became nullable for the status 201

      response-property-became-nullable

    • the response property url became nullable for the status 201

      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