Create Webhook

Create Webhook

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

Registers a new webhook URL for a specific role.

Only one URL per scope is allowed. If a webhook is already registered for the given role, it will be overwritten.

Available webhook roles:

• transactions

• remittances

• clients

• simple_transactions

• simple_remittances

• simple_moneygram

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.

Request Body

Create Webhook

{
	"url": "http://frentecorretora.com.br",
    "role": "transactions"
}

Response

200 - Success

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

400 - Invalid URL

400 - Already Exists