Catálogo de eventos | Desenvolvedores Steel

Catálogo de eventos

Cada evento de webhook que o Steel envia, com o momento em que dispara, o corpo completo de exemplo e o significado de cada campo do data.

Nesta página

Todo evento chega com o mesmo envelope; muda só o data. Esta página mostra o corpo completo de cada tipo, com os dados de exemplo que o steel trigger também usa. Para receber e conferir as entregas, veja Receber os webhooks do Steel.

O envelope

Campo	Tipo	O que é
`id`	texto	Id do evento (`evt_...`). O mesmo em todas as tentativas e no cabeçalho `Steel-Webhook-Id`: use para não processar duas vezes
`type`	texto	O tipo, como nas seções abaixo
`createdAt`	data ISO 8601 (UTC)	Quando o evento aconteceu no Steel. Use para ordenar: a ordem de chegada não é garantida
`workspaceId`	texto	O workspace de origem
`data`	objeto	O conteúdo do tipo

Regras do data, as mesmas da API v1: campos novos e opcionais podem aparecer a qualquer momento (ignore o que não conhece); nada é removido, muda de tipo ou passa a ser obrigatório sem um tipo de evento novo e aviso prévio. Datas vêm sempre em UTC. Os campos actorId são o id do usuário que fez a ação, ou null quando foi o sistema (uma automação, o SLA, um canal externo).

O catálogo vivo, com os tipos dos módulos do seu token, está em GET /api/v1/webhooks/events e em steel webhooks events.

Tipo	Módulo
`servicedesk.ticket.created`	ServiceDesk
`servicedesk.ticket.updated`	ServiceDesk
`servicedesk.ticket.assigned` e os outros avisos do chamado	ServiceDesk
`crm.lead.created`	CRM

crm.opportunity.stage_changed

{
  "id": "evt_cm2x7k3p0000abcd",
  "type": "servicedesk.ticket.created",
  "createdAt": "2026-10-18T12:00:00.000Z",
  "workspaceId": "cm2ws0001",
  "data": {
    "ticket": {
      "id": "cm2tkt000000example",
      "number": 123,
      "code": "INC-000123",
      "title": "Impressora do financeiro sem conexão",
      "type": "INCIDENT",
      "channel": "PORTAL",
      "phase": {
        "id": "cm2phs000000example",
        "name": "Em atendimento",
        "category": "IN_PROGRESS"
      },
      "priority": {
        "id": "cm2pri000000example",
        "name": "Alta"
      },
      "departmentId": null,
      "assigneeId": "cm2usr000000example",
      "requesterId": null,
      "createdAt": "2026-10-18T12:00:00.000Z",
      "updatedAt": "2026-10-18T12:05:00.000Z"
    },
    "actorId": "cm2usr000000example"
  }
}

Campo de `data.ticket`	O que é
`id`, `number`, `code`	Id, número e código com o prefixo do workspace (`INC-000123`)
`title`	Título
`type`	`INCIDENT`, `SERVICE_REQUEST`, `CHANGE` ou `PROBLEM`
`channel`	Por onde chegou: `AGENT`, `PORTAL`, `EMAIL`, `WHATSAPP`, `PHONE`, `AI` ou `API`
`phase`	Fase atual (`id`, `name`, `category`: `NEW`, `IN_PROGRESS`, `WAITING`, `RESOLVED`, `CLOSED` ou `CANCELED`)
`priority`	`{ id, name }` ou `null`
`departmentId`, `assigneeId`, `requesterId`	Ids, ou `null`
`createdAt`, `updatedAt`	Datas ISO 8601

{
  "id": "evt_cm2x7k3p0000abcd",
  "type": "servicedesk.ticket.updated",
  "createdAt": "2026-10-18T12:00:00.000Z",
  "workspaceId": "cm2ws0001",
  "data": {
    "ticket": {
      "id": "cm2tkt000000example",
      "number": 123,
      "code": "INC-000123",
      "title": "Impressora do financeiro sem conexão",
      "type": "INCIDENT",
      "channel": "PORTAL",
      "phase": {
        "id": "cm2phs000000example",
        "name": "Em atendimento",
        "category": "IN_PROGRESS"
      },
      "priority": {
        "id": "cm2pri000000example",
        "name": "Alta"
      },
      "departmentId": null,
      "assigneeId": "cm2usr000000example",
      "requesterId": null,
      "createdAt": "2026-10-18T12:00:00.000Z",
      "updatedAt": "2026-10-18T12:05:00.000Z"
    },
    "actorId": "cm2usr000000example",
    "change": "fields"
  }
}

Tipo	Quando	`summary.title` de exemplo	`summary.body` de exemplo
`servicedesk.ticket.assigned`	Chamado atribuído a um atendente.	Chamado atribuído a você	INC-000123 — Impressora do financeiro sem conexão
`servicedesk.ticket.message`	Nova mensagem pública no chamado.	Nova mensagem no chamado	A impressora voltou a funcionar, obrigado!
`servicedesk.ticket.resolved`	Chamado resolvido.	Chamado resolvido	INC-000123 foi resolvido.
`servicedesk.ticket.reopened`	Chamado reaberto.	Chamado reaberto	INC-000123 foi reaberto pelo solicitante.
`servicedesk.ticket.escalated`	Chamado escalonado por regra ou manualmente.	Chamado escalonado	INC-000123 foi escalonado para o nível 2.
`servicedesk.ticket.csat`	Solicitante avaliou o atendimento (CSAT).	Avaliação recebida	Nota 5 de 5.
`servicedesk.sla.at_risk`	SLA do chamado em risco.	SLA em risco	Faltam 30 minutos para vencer a resolução.
`servicedesk.sla.breached`	SLA do chamado violado.	SLA violado	O prazo de resolução venceu.
`servicedesk.approval.requested`	Aprovação solicitada no chamado.	Aprovação solicitada	A mudança aguarda a sua aprovação.
`servicedesk.approval.responded`	Aprovação respondida (aprovada ou recusada).	Aprovação respondida	A mudança foi aprovada.

{
  "id": "evt_cm2x7k3p0000abcd",
  "type": "servicedesk.sla.at_risk",
  "createdAt": "2026-10-18T12:00:00.000Z",
  "workspaceId": "cm2ws0001",
  "data": {
    "ticket": {
      "id": "cm2tkt000000example",
      "number": 123,
      "code": "INC-000123",
      "title": "Impressora do financeiro sem conexão"
    },
    "actorId": "cm2usr000000example",
    "summary": {
      "title": "SLA em risco",
      "body": "Faltam 30 minutos para vencer a resolução."
    }
  }
}

{
  "id": "evt_cm2x7k3p0000abcd",
  "type": "crm.lead.created",
  "createdAt": "2026-10-18T12:00:00.000Z",
  "workspaceId": "cm2ws0001",
  "data": {
    "lead": {
      "id": "cm2lead00000example",
      "name": "Maria Souza",
      "emails": [
        "maria@example.com"
      ],
      "phones": [
        "+5511999990000"
      ],
      "company": "Acme Ltda",
      "source": "site",
      "channel": "FORM",
      "score": 40,
      "ownerId": null,
      "createdAt": "2026-10-18T12:00:00.000Z"
    }
  }
}

Campo de `data.lead`	O que é
`emails`, `phones`	Listas; pelo menos uma delas tem item
`source`, `channel`	Origem e canal informados, ou `null`
`score`	Pontuação calculada na entrada
`ownerId`	Dono escolhido pelas regras de roteamento, ou `null`

{
  "id": "evt_cm2x7k3p0000abcd",
  "type": "crm.opportunity.stage_changed",
  "createdAt": "2026-10-18T12:00:00.000Z",
  "workspaceId": "cm2ws0001",
  "data": {
    "opportunity": {
      "id": "cm2opp000000example",
      "name": "Renovação do contrato de suporte",
      "amount": 12000,
      "pipelineId": "cm2pip000000example",
      "ownerId": "cm2usr000000example"
    },
    "fromStage": {
      "id": "cm2stg00000example1",
      "name": "Proposta",
      "category": "OPEN"
    },
    "toStage": {
      "id": "cm2stg00000example2",
      "name": "Negociação",
      "category": "OPEN"
    },
    "actorId": "cm2usr000000example"
  }
}

{
  "id": "evt_cm2x7k3p0000abcd",
  "type": "crm.deal.won",
  "createdAt": "2026-10-18T12:00:00.000Z",
  "workspaceId": "cm2ws0001",
  "data": {
    "source": "opportunity",
    "id": "cm2opp000000example",
    "name": "Renovação do contrato de suporte",
    "amount": 12000,
    "ownerId": "cm2usr000000example",
    "actorId": "cm2usr000000example"
  }
}

{
  "id": "evt_cm2x7k3p0000abcd",
  "type": "crm.deal.lost",
  "createdAt": "2026-10-18T12:00:00.000Z",
  "workspaceId": "cm2ws0001",
  "data": {
    "source": "lead",
    "id": "cm2lead00000example",
    "name": "Renovação do contrato de suporte",
    "amount": 12000,
    "ownerId": "cm2usr000000example",
    "actorId": "cm2usr000000example"
  }
}

{
  "id": "evt_cm2x7k3p0000abcd",
  "type": "communication.message.received",
  "createdAt": "2026-10-18T12:00:00.000Z",
  "workspaceId": "cm2ws0001",
  "data": {
    "message": {
      "id": "cm2msg000000example",
      "conversationId": "cm2cnv000000example",
      "type": "TEXT",
      "text": "Olá, gostaria de um orçamento.",
      "providerMessageId": "wamid.example",
      "receivedAt": "2026-10-18T12:00:00.000Z"
    },
    "contact": {
      "id": "cm2ctt000000example",
      "waId": "5511999990000",
      "name": "Maria"
    },
    "connectionId": "cm2con000000example"
  }
}

Campo	O que é
`message.type`	`TEXT`, `IMAGE`, `AUDIO`, `VIDEO`, `DOCUMENT`, `STICKER`, `LOCATION`, `BUTTON`, `CONTACT`...
`message.text`	O texto, ou a legenda da mídia; `null` quando não há
`message.providerMessageId`	Id da mensagem no provedor (`wamid...` na Meta)
`contact.waId`	Número do WhatsApp só com dígitos (DDI + DDD + número)
`connectionId`	A conexão que recebeu

{
  "id": "evt_cm2x7k3p0000abcd",
  "type": "communication.conversation.waiting",
  "createdAt": "2026-10-18T12:00:00.000Z",
  "workspaceId": "cm2ws0001",
  "data": {
    "conversation": {
      "id": "cm2cnv000000example",
      "status": "NEW",
      "connectionId": "cm2con000000example",
      "teamId": null,
      "aiActive": false,
      "unreadCount": 1,
      "lastMessageAt": "2026-10-18T12:00:00.000Z",
      "createdAt": "2026-10-18T12:00:00.000Z"
    },
    "contact": {
      "id": "cm2ctt000000example",
      "waId": "5511999990000",
      "name": "Maria"
    },
    "reason": "new",
    "actorId": null
  }
}

Campo	O que é
`reason`	`new`: o contato abriu uma conversa nova; `reopened`: uma conversa fechada foi reaberta (pelo contato ou por um atendente) sem responsável; `returned_to_queue`: o responsável saiu (devolvida para a fila, ou um botão de resposta a moveu para a fila de uma equipe)
`conversation.teamId`	Fila da equipe em que a conversa espera; `null` = fila geral
`conversation.aiActive`	`true` quando a IA está respondendo enquanto ninguém assume
`actorId`	Quem devolveu ou reabriu; `null` quando foi o contato ou uma automação

{
  "id": "evt_cm2x7k3p0000abcd",
  "type": "agents.approval.pending",
  "createdAt": "2026-10-18T12:00:00.000Z",
  "workspaceId": "cm2ws0001",
  "data": {
    "agent": {
      "id": "cm2agt000000example",
      "name": "Triagem de leads"
    },
    "runId": "cm2run000000example",
    "count": 2
  }
}

{
  "id": "evt_cm2x7k3p0000abcd",
  "type": "steel.ping",
  "createdAt": "2026-10-18T12:00:00.000Z",
  "workspaceId": "cm2ws0001",
  "data": {
    "message": "Teste de webhook do Steel"
  }
}

Catálogo de eventos

O envelope

ServiceDesk

servicedesk.ticket.created

servicedesk.ticket.updated

Avisos do chamado

CRM

crm.lead.created

Oportunidade mudou de etapa

crm.deal.won e crm.deal.lost

Comunicação

communication.message.received

communication.conversation.waiting

Steel Agents

agents.approval.pending

Plataforma

steel.ping