Get webhook

Information

---

This API allow you to get one webhook by id.

This endpoint is synchronous

The role admin is needed in order to use this endpoint

Endpoints

---

GET/v1/config/webhook/{webhookId}

---

Path parameters

---

webhookIdstring (uuid) - Required

---

Response

---

Status: 200 - application/json

Description: Returns webhook details

Schema:

• webhookId: string
  Unique webhook identifier
• filterStreamDirection: enum
  Optional direction filter for the webhook stream
• status: enum
  Status of the webhook, either ACTIVE or INACTIVE
• adapterCode: string
  The adapter code to use for the webhook, default is "standardAdapter"
• label: string
  An optional label for the webhook
• interopData: object
  The interop data that configures webhook behavior

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.

---