Sign in

v1

latestOpenAPI 3.1.02026-07-26223346.1 KB
Webhooks

put/webhooks/{id}

Path parameters

idstring required

Request body

namestring
urlstring
productsstring
triggersstring[]
tokenstring

Example request

{
  "name": "meu webhook",
  "url": "https://webhook.site/73d28a2b-6c48-41e0-a8ad-0d5ef748ce41",
  "products": "all",
  "triggers": [
    "boleto_gerado",
    "pix_gerado",
    "carrinho_abandonado",
    "compra_recusada",
    "compra_aprovada",
    "compra_reembolsada",
    "chargeback",
    "subscription_canceled",
    "subscription_late",
    "subscription_renewed"
  ],
  "token": "w9i3pvutvxe"
}

Response

Webhook data

idstring
namestring
urlstring
productsstring
triggersstring[]
tokenstring
created_atstring
updated_atstring

Example response

{
  "id": "3d379edc-9e21-47ee-8974-ca80a4c7839d",
  "name": "Meu Webhook",
  "url": "https://webhook.site/73d28a2b-6c48-41e0-a8ad-0d5ef748ce41",
  "products": "all",
  "triggers": [
    "boleto_gerado",
    "pix_gerado",
    "carrinho_abandonado",
    "compra_recusada",
    "compra_aprovada",
    "compra_reembolsada",
    "chargeback",
    "subscription_canceled",
    "subscription_late",
    "subscription_renewed"
  ],
  "token": "rxue90njjv1",
  "created_at": "2023-11-24T10:06:47.540Z",
  "updated_at": "2023-11-24T10:06:47.540Z"
}