Version: Next

List my webhooks

Information

This API allow you to get all webhook you created.

This endpoint is synchronous

The role admin is needed in order to use this endpoint

Endpoints

GET/v1/config/webhook

GET /v1/config/webhook

  curl -X 'GET'
    'https://api.ppd.iopole.fr//v1/config/webhook'
    -H 'accept: application/json'
    -H 'Authorization: Bearer ${token}'

Response

Description: Returns list of configured webhooks

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

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

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