YAyampi
Webhooks

Atualizar um webhook

Changed on

Atualiza um webhook específico

put/{alias}/webhooks/{id}

Request

  • Base URL
    https://api.dooki.com.br/v2
  • URL
    https://api.dooki.com.br/v2/{alias}/webhooks/{id}
  • Auth
    API key in header User-Token and API key in header User-Secret-Key

Path parameters

aliasstring required

Alias da loja

idinteger required

ID do webhook

Request body

urlstring uri required

URL para onde os eventos serão enviados

eventsstring[] required

Lista de eventos para os quais o webhook será acionado

namestring required

Nome do webhook

Example request

{
  "url": "https://suaurl.com/api/webhooks",
  "events": [
    "order.created",
    "cart.reminder"
  ],
  "name": "Nome do webhook"
}

Response

Webhook atualizado com sucesso

idinteger

ID do webhook.

activeboolean

Indica se o webhook está ativo e recebendo os eventos assinados.

namestring

Nome do webhook

urlstring uri

URL para onde os eventos serão enviados

secret_keystring

Chave secreta de 40 caracteres usada para gerar a assinatura HMAC enviada nas requisições do webhook, permitindo validar a origem do evento.

Example response

{
  "name": "Webhook de integração com CRM",
  "url": "https://suaurl.com/api/webhooks",
  "disabled_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "created_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "updated_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  }
}

Changes