Pular para o conteúdo

Update a webhook

Updates an existing webhook URL and/or notification type for the given webhookId.

PATCH/api/v1/webhooks/{webhookId}

Update sub-tenant webhook

Patches webhook settings such as callback URL or subscribed notification category.

Auth: Bearer Token

Parâmetros de path

1 campo
webhookId●
pathstring

Webhook id to update.

Corpo da requisição

3 campos
webhookUrl●
bodystring

New HTTPS callback URL.

subTenantId●
bodystring

Sub-tenant business identifier (must match the webhook owner).

type●
bodystring

Notification category.

curl --request PATCH \
  --url 'https://embedded-payment-manager.hml.linaob.com.br/api/v1/webhooks/webhook123' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <SEU_TOKEN>' \
  --data '{
  "webhookUrl": "https://api.example.com/lina/webhook-v2",
  "subTenantId": "subTenant123",
  "type": "AUTOMATIC_PAYMENT"
}'

Response

200Webhook updated successfully.
Response body
object
  • dataobjectrequired
    • idstringrequired

      Webhook id.

    • subTenantstringrequired

      Sub-tenant identifier.

    • webhookUrlstringrequired

      Updated callback URL.

    • typestringrequired

      Notification category.

  • messagestring

    Response message.

  • typestring

    Envelope type.

  • statusCodenumber· nullable

    HTTP status in the envelope.

200 · Webhook updated successfully.
{
  "data": {
    "id": "webhook123",
    "subTenant": "subTenant123",
    "webhookUrl": "https://api.example.com/lina/webhook-v2",
    "type": "AUTOMATIC_PAYMENT"
  },
  "message": "",
  "type": "success",
  "statusCode": 200
}

Next steps