O que esse endpoint de API faz

Com a API Webhooks, você cria ou exclui webhooks dos eventos de webhook disponíveis. Quem tem acesso ao aplicativo para o qual o webhook está enviando as informações vê a conclusão do curso, o envio do curso para publicação, a inscrição de usuários e grupos em cursos e planos de aprendizagem ou quando um usuário é adicionado à sua conta do Reach 360.

Você também pode usar esse endpoint para obter uma lista de webhooks ou detalhes de um webhook específico.

Observação: a API Webhooks oferece suporte à assinatura de mensagens. Ao criar um webhook, você pode especificar umsharedSecret, que é usado para gerar uma assinatura para cada solicitação, garantindo a autenticidade das mensagens recebidas.

• Pontos finais
• Objetos
• Crie um webhook
• Listar webhooks
• Recupere o Webhook por ID
• Excluir Webhook por ID

Pontos finais

• POST /webhooks- crie um novo webhook
• GET /webhooks- listar webhooks
• GET /webhooks/{webhookId}- obtenha detalhes de um webhook por id de webhook
• DELETE /webhooks/{webhookId}- exclua um webhook pelo id do webhook

Objetos

• id(string) - o identificador exclusivo do webhook
• targetUrl(string) - o URL do endpoint do webhook em seu servidor
• sharedSecret(string) - um segredo usado para gerar uma assinatura para cada solicitação. Retornado somente ao criar um webhook
• events(lista de eventos de webhook) - a lista de eventos de webhook habilitados para este webhook
• apiVersion(string) - Versão da API usada ao enviar o evento webhook

Crie um webhook

POST /webhooks

Parâmetros de solicitação (JSON)

• targetUrl(string, obrigatório)
• events(lista de eventos de webhook, obrigatória)
• sharedSecret(string, opcional)
• apiVersion(string, opcional) - Versão da API a ser usada para o evento webhook. Se não for fornecido, usará como padrão o API-Version cabeçalho enviado na solicitação ou, se isso não for especificado, a versão inicial da API, 2023-04-04

Exemplo de resposta

{
  "id": "example-webhook-id",
  "targetUrl": "<https://example.com>",
  "events": ["course.completed", "user.created"],
  "sharedSecret": "the shared secret",
  "apiVersion": "2023-05-04",
  "url": "<https://api.reach360.com/webhooks/example-webhook-id>",
}

Códigos de erro específicos do endpoint:

• duplicate_target_url- não é possível criar um webhook porque ele já targetUrl está sendo usado por outro webhook. Uma resposta 409 será retornada neste caso.

Listar webhooks

GET /webhooks

Parâmetros de solicitação (sequência de caracteres de consulta)

• limit(inteiro, opcional) - o número máximo de resultados a serem retornados em uma única resposta (consulte Paginação); deve estar entre 1 e 2000 (o padrão é 50)

Exemplo de resposta

{
  "webhooks": [
    {
      "id": "example-webhook-id",
      "targetUrl**":** "<https://example.com>",
      "events": ["course.completed", "user.created"],
      "apiVersion": "2023-05-04",
      "url": "<https://api.reach360.com/webhooks/example-webhook-id>"
    ****}, ...
  ],
  "nextUrl": "<https://url-for-next-page-of-results>"
}

Recupere o Webhook por ID

OBTENHA /webhooks/ {webhookID}

Exemplo de resposta

{
  "id": "example-webhook-id",
  "targetUrl": "<https://example.com>",
  "events": ["course.completed", "user.created"],
  "apiVersion": "2023-05-04",
  "url": "<https://api.reach360.com/webhooks/example-webhook-id>"
****}

Códigos de erro específicos do endpoint:

• webhook_not_found- não é possível recuperar o webhook porque o webhook não existe

Excluir Webhook por ID

EXCLUIR /webhooks/ {webhookID}

Resposta de sucesso

204 “Sem conteúdo”

Códigos de erro específicos do endpoint:

• webhook_not_found- não é possível excluir o webhook porque o webhook não existe