A etapa Webhook é a forma mais simples de integração da plataforma. É uma etapa em que o usuário deve realizar alguma ação em um outro sistema e é finalizada quando o sistema notifica a plataforma da Comunitive.

Etapa Webhook

Ao adicionar uma etapa do tipo Webhook em um desafio será criado um endereço URL para que você envie notificações. A etapa somente será completa quando a plataforma da Comunitive receber uma chamada do tipo POST no link gerado, informando o usuário que completou a etapa.

Atenção: Os endereços URL utilizados a seguir servem apenas como exemplo. Crie um desafio com uma etapa do tipo Webhook e copie o endereço do webhook fornecido.

Concluir Etapa

POST https://api.peepi.com.br/steps/31/webhook/dsah-sn2-dshu

{
  "user": "ricardo@comunitive.com.br",
  "points": 0, // Pontuação adicional da etapa (opcional)
  "data": { // Objeto com informações do resultado (opcional)
    "codigo_venda": "COD-123", // Exemplo
  }
}

Cancelar Resultado Etapa

DELETE https://api.peepi.com.br/steps/31/webhook/dsah-sn2-dshu

{
  "user": "ricardo@comunitive.com.br",
  "reason": "string", // Motivo do cancelamento (opcional)
  "data": { // Objeto com informações do resultado (opcional)
    "codigo_venda": "COD-123", // Exemplo
  }
}