Update webhook

Information

---

This API allow you to update a webhook.

This endpoint is synchronous

The role admin is needed in order to use this endpoint

Endpoints

---

PUT/v1/config/webhook/{webhookId}

---

Information

You can update the whole object or only one property. The example below only update the label of the webhook.

Path parameters

---

webhookIdstring (uuid) - Required

---

Body parameters

---

filterStreamDirectionenum

Optional direction filter for the webhook stream

---

statusenum - Default value : ACTIVE

Status of the webhook, either ACTIVE or INACTIVE

---

adapterCodestring - Default value : standardAdapter

The adapter code to use for the webhook, default is "standardAdapter"

---

labelstring

An optional label for the webhook

---

interopDataobject

The interop data that configures webhook behavior

PUT /v1/config/webhook/:webhookId

  curl -X 'PUT'
  'https://api.ppd.iopole.fr//v1/config/webhook/6c6147a9-b820-4627-8baf-58f32ca256a7'
  -H 'accept: application/json'
  -H 'Authorization: Bearer ${token}'
  -H 'Content-Type: application/json'
  -d '{
    "label": "test"
  }'

Response

---

Status: 201 - application/json

Description: Returns updated webhook id

Schema:

• type: enum
  The type of the response object.
• id: string
  The unique identifier for the created element.

Examples:

{
  "type": "WEBHOOK",
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}

Status: 401

Description: Unauthorized - Authentication is required and has failed or has not yet been provided.

Status: 403

Description: Forbidden - The server understood the request, but it refuses to authorize it. Note: This endpoint requires an admin account.

Status: 404

Description: Error - No webhook found for given id

---