Eventos e Payloads de Webhook - Topsort Documentation

Abaixo está um exemplo de resposta de evento 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 varia dependendo do evento, que é abordado em detalhes abaixo

{
  "channel": "campaign:update",
  "timestamp": "2024-10-31T14:42:55.759185Z",
  "id": "gUo",
  "payload": {
    "name": "Minha campanha",
    "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.

{
  "channel": "campaign:create",
  "timestamp": "2024-10-31T14:42:55.759185Z",
  "id": "gUo",
  "payload": {
    "name": "Minha campanha",
    "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 by ID.

{
  "channel": "campaign:update",
  "timestamp": "2024-10-31T14:42:55.759185Z",
  "id": "gUo",
  "payload": {
    "name": "Meu novo nome de campanha",
    "campaign_id": "edac69a3-3ca2-41d6-af9e-08d3126099b4"
  }
}

Exclusão de Campanha

Acionado quando uma campanha é excluída.

{
  "channel": "campaign:delete",
  "timestamp": "2024-10-31T14:42:55.759185Z",
  "id": "gUo",
  "payload": {
    "name": "Minha campanha",
    "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"
  }
}

​Criação de Campanha

​Atualização de Campanha

​Exclusão de Campanha

Criação de Campanha

Atualização de Campanha

Exclusão de Campanha