search

Show Webhook

hashtag
Show Webhook

GET {{Environment_URL}}/v1/notifications/webhooks/:role/:correspondentId

Returns the webhook configuration registered for a specific correspondent and role.

Use this endpoint to check the current webhook URL associated with a given role.

Headers

Name
Value

Authorization

Bearer <token>

Path Params

Name
Value
Description

role

clients

Role of the webhook to create

correspondentId

1

Correspondent ID associated with the authenticated user. Obtainable via the /validate route.

Response

{
    "id": 3,
    "url": "http://frentecorretora.com.br",
    "role": "transactions",
    "correspondent_id": 1
}