Skip to main content
PUT
https://api.sandbox.wepayout.com.br
/
v2
/
register
/
companies
/
webhooks
/
{id}
Update
curl --request PUT \
  --url https://api.sandbox.wepayout.com.br/v2/register/companies/webhooks/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>"
}
'
{
  "event": "onboarding",
  "url": "https://my-url.requestcatcher.com/test"
}

​
Update Webhook URL

This endpoint allows updating the webhook URL associated with a specific event.
  • The event parameter must be provided in the path
  • The request body should include the new configuration values for the specified event’s webhook URL

​
Path Parameters

​
event
string
required
The event type for which to update the webhook URLExample: onboarding

​
Request Body

​
url
string
required
Endpoint URL that will receive the webhook notifications for the selected event.URL characters: a-z, A-Z charactersExample: https://my-url.requestcatcher.com/test

​
Response

​
event
string
Type of event that was registered for the webhookAllowed values: onboarding
​
url
string
Endpoint URL that was registered to receive webhook notificationsExample: https://my-url.com/test

​
Request Example

curl --request PUT \
  --url https://api.sandbox.wepayout.com.br/v2/register/companies/webhooks/onboarding \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "https://my-url.requestcatcher.com/test"
  }'

{
  "event": "onboarding",
  "url": "https://my-url.requestcatcher.com/test"
}