Create a webhook
POST {{baseUrl}}/{{version}}/webhook
Here you can register a new webhook URL. The subscriptions refer to which kind of log will be notified to the webhook URL being registered. The subscriptions must be in transfer, boleto, boleto-payment, utility-payment.
| Parameters | Value Type | Description |
|---|---|---|
| url | REQUIRED | The server URL that will receive the webhook events |
| subscriptions | REQUIRED | Array of subscriptions. Possible values: boleto, boleto-payment, transfer, utility-payment |
Request Body
{"url"=>"https://webhook.site/287d2ec8-bc67-4a1e-83b9-d3151ebfcfb7", "subscriptions"=>["boleto", "boleto-payment"]}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"message":"Webhook successfully created","webhook":{"url":"https://winterfell.westeros.gov/events-from-stark-bank","id":"5674228498038784","subscriptions":["boleto","boleto-payment","transfer","utility-payment"]}}