> ## Documentation Index
> Fetch the complete documentation index at: https://docs.topsort.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Eventos e payloads de Webhook

> Conheça as especificações de eventos e payloads para webhooks.

## Exemplo de resposta de evento

A seguir está um exemplo de uma resposta de evento de webhook para uma atualização de campanha. Os campos comuns para todos os eventos são:

* `channel`: O tipo de evento que ocorreu
* `timestamp`: Quando o evento ocorreu
* `id`: ID único para o evento que pode ser usado para deduplicação
* `payload`: O payload contém os detalhes do evento e variará de acordo com o evento, o que é coberto em detalhes abaixo

```json theme={null}
{
  "channel": "campaign:update",
  "timestamp": "2024-10-31T14:42:55.759185Z",
  "id": "gUo",
  "payload": {
    "name": "My campaign",
    "campaign_id": "edac69a3-3ca2-41d6-af9e-08d3126099b4"
  }
}
```

## Criação de campanha

É acionado quando uma campanha é criada. Para ver a especificação completa do payload, consulte a resposta da API [Campaign Create](/en/api-reference/campaign-api/create-campaign).

```json theme={null}
{
  "channel": "campaign:create",
  "timestamp": "2024-10-31T14:42:55.759185Z",
  "id": "gUo",
  "payload": {
    "name": "My campaign",
    "campaign_id": "edac69a3-3ca2-41d6-af9e-08d3126099b4"
  }
}
```

## Atualização de campanha

É acionado quando uma campanha é atualizada. Para ver a especificação completa do payload, consulte a resposta da API [Campaign Update](/en/api-reference/campaign-api/update-campaign-by-id).

```json theme={null}
{
  "channel": "campaign:update",
  "timestamp": "2024-10-31T14:42:55.759185Z",
  "id": "gUo",
  "payload": {
    "name": "My new campaign name",
    "campaign_id": "edac69a3-3ca2-41d6-af9e-08d3126099b4"
  }
}
```

## Exclusão de campanha

É acionado quando uma campanha é excluída.

```json theme={null}
{
  "channel": "campaign:delete",
  "timestamp": "2024-10-31T14:42:55.759185Z",
  "id": "gUo",
  "payload": {
    "name": "My campaign",
    "ad_format": "listing",
    "vendor_id": "2355d342-222e-4dc9-af92-81c3865b3b66",
    "campaign_id": "edac69a3-3ca2-41d6-af9e-08d3126099b4",
    "campaign_type": "autobidding",
    "marketplace_id": "ad666c53-b174-497a-b52f-77354947456c"
  }
}
```