Update Webhook EndPoint

Update Webhook EndPoint

PATCH {{Environment_URL}}/events/v1/webhooks/:id

Update a webhook URL.

It is possible to register more than one URL for each scope. When updating a webhook, only the entry with the specified id will be modified — other registered URLs for the same scope remain unchanged

Headers

Name	Value
Authorization	Bearer <token>

Path Variables

Name	Value
id	we_01k9ta206722rj53t7jqrc95me

Body

Field	Type	Description	Example
url	string	The endpoint URL that will receive webhook events.	"https://example.com/webhook"
description	string	A short description for the webhook endpoint.	"Webhook for PIX and withdrawal events"
events	array[string]	A list of event types that will trigger notifications.	["charge.succeeded", "withdrawal.pending"]
metadata	object	Optional field for any custom data you want returned in webhook payloads.	{"myId": "myValue"}

Request Body

Update Webhook EndPoint

{
  "url": "https://example.com/webhook",
  "description": "Webhook for PIX and withdrawal events",
  "events": [
    "charge.succeeded",
    "withdrawal.pending"
  ],
  "metadata": {
    "myId": "myValue"
  }
}

Response

200 - OK

{
  "data": [
    {
      "metadata": {
        "myId": "myValue"
      },
      "id": "we_01k9ta206722rj53t7jqrc95me",
      "url": "https://example.com/webhook",
      "secret": "{{secret}}",
      "enabled": true,
      "description": "string",
      "createdAt": "2025-11-11T20:34:59.906Z",
      "events": [
        "charge.canceled",
        "charge.created",
        "charge.expired",
        "charge.failed",
        "charge.pending",
        "charge.refunded",
        "charge.succeeded",
        "payment-link.created",
        "payment-link.pending",
        "payment-link.succeeded",
        "payment-link.canceled",
        "payment-link.expired",
        "withdrawal.created",
        "withdrawal.validated",
        "withdrawal.available",
        "withdrawal.pending",
        "withdrawal.succeeded",
        "withdrawal.failed",
        "transaction.created",
        "transaction.succeeded",
        "transaction.pending",
        "transaction.failed",
        "transaction.refunded",
        "transaction.canceled"
      ]
    }
  ],
  "count": 1,
  "total": 1,
  "page": 1,
  "pageCount": 1
}