Documentacao da API IAra Help Center
Principal Website
Principal
Categories
🧭 Escopo e primeiros passos
  • Escopo publico da API IAra
  • Base URL, autenticacao e IDs
  • Mapa completo dos recursos de conta
  • Paginacao, filtros e respostas
🪪 Contatos e identificadores
  • Contatos: criar, listar, buscar e atualizar
  • Contatos: filtros, labels, merge e contact inboxes
💬 Conversas e mensagens
  • Conversas: listar, criar, filtrar e atualizar
  • Conversas: atribuicao, status, prioridade, labels e atributos
  • Mensagens, anexos e eventos da conversa
🔌 Client API e canais proprios
  • Client API: criar contato, conversa e mensagem
  • Client API: status, typing, last seen e historico
⚙️ Organizacao da conta
  • Agentes, times, perfil e dados da conta
  • Caixas de entrada e canais
  • Etiquetas, respostas prontas, atributos e filtros
⚡ Automacoes e webhooks
  • Webhooks, automacoes e integration hooks
📊 Relatorios e auditoria
  • Relatorios da conta e metricas de atendimento
  • CSAT, audit logs e eventos de conversa
📚 Central de ajuda via API
  • Portais, categorias e artigos via API
🛠️ Erros e boas praticas
  • Erros HTTP e diagnostico de integracoes
  • Boas praticas de integracao
Principal ⚡ Automacoes e webhooks
⚡

Automacoes e webhooks

1 artigo · Suporte Por Suporte
1 artigo · Suporte Por Suporte

Webhooks, regras de automacao e hooks de integracao disponiveis no escopo da conta.

Webhooks, automacoes e integration hooks

Webhooks, automacoes e integration hooks Use webhooks para enviar eventos da IAra a sistemas externos. Use regras de automacao e hooks de integracao quando estiverem habilitados para a conta. Webhooks curl -X POST "$BASE_URL/api/v1/accounts/$ACCOUNT_ID/webhooks" \ -H "api_access_token: $API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "name":"CRM Digi2B", "url":"https://integracoes.digi2b.com/webhooks/iara", "subscriptions":["conversation_created", "message_created", "contact_updated"] }' Eventos comuns incluem conversation_created, conversation_status_changed, conversation_updated, message_created, message_updated, contact_created, contact_updated, webwidget_triggered, conversation_typing_on e conversation_typing_off. Automation rules Rotas de /automation_rules permitem listar, criar, atualizar e remover regras quando o usuario tiver permissao. Integration hooks Rotas de /integrations/apps e /integrations/hooks servem para integracoes suportadas na conta. Cuidados O endpoint receptor do webhook deve responder rapido com status 2xx. Para processamento pesado, coloque o evento em fila e responda antes.

Feito com Iara Iara