Webhooks

Por meio deste endpoint, você pode criar, visualizar e excluir webhooks. Alternativamente, você pode gerenciar seus webhooks no aplicativo web na seção Desenvolvedor.

GET/api/hooks

Ler Webhooks

Consulte os webhooks ativos da sua conta.

Requisição

GET
/api/hooks
curl -G "https://gateway.seven.io/api/hooks" \
    -H "X-Api-Key: SUA_CHAVE_API"

Resposta

{
  "success": true,
  "code": null,
  "hooks": [
    {
      "id": "410",
      "target_url": "https://acme.inc/v1/webhooks",
      "headers": "",
      "event_type": "sms_mo",
      "event_filter": "49157123456789",
      "request_method": "GET",
      "enabled": true,
      "created": "2021-03-01 11:19:08"
    },
    {
      "id": "1277",
      "target_url": "https://hooks.seven.io/hook",
      "headers": "Authorization: Basic dXNlcjpwYXNz",
      "event_type": "all",
      "event_filter": null,
      "request_method": "JSON",
      "enabled": false,
      "created": "2021-12-30 13:33:02"
    }
  ]
}
POST/api/hooks

Registrar Webhook

Parâmetros

  • Name
    target_url
    Type
    string
    Description

    Endereço de destino do seu webhook

  • Name
    headers
    Type
    string
    Description

    Cabeçalhos HTTP que você deseja enviar com o webhook. Por exemplo, para autenticação. Vários cabeçalhos são separados por \n.

  • Name
    event_type
    Type
    enum
    Description

    Tipo de evento para o qual você deseja receber um webhook.

    Mostrar eventos

    all – Envia todos os eventos
    rcs - Eventos RCS e mensagens RCS recebidas
    sms_mo – Novo SMS recebido
    dlr – Relatórios de status dos seus SMS
    voice_call – Informações sobre chamadas recebidas em Voicecalls
    voice_status – Atualizações para Voicecalls
    voice_dtmf – Sinais DTMF em Voicecalls
    tracking – Cliques ou visualizações do Performance Tracking

  • Name
    event_filter
    Type
    string
    Optional
    Optional
    Description

    Opcional. Envia o webhook apenas se o filtro corresponder. Por exemplo, para diferentes webhooks em diferentes números de entrada.

  • Name
    request_method
    Type
    enum
    Optional
    Optional
    Description

    Método de requisição no qual você deseja receber o webhook.

    POST - Dados são enviados como uma solicitação HTTP POST como application/x-www-form-urlencoded (Padrão) GET - Dados são enviados como parâmetros HTTP GET JSON - Dados são enviados via HTTP POST como carga JSON

Anfrage

POST
/api/hooks
curl -X POST "https://gateway.seven.io/api/hooks" \
    -H "X-Api-Key: IHR_API_SCHLÜSSEL" \
    -d "target_url=https://acme.inc/webhook/" \
    -d "event_type=all"

Antwort

{
    "success": true,
    "code": null,
    "id": 12345,
    "error_message": null
}
DELETE/api/hooks

Excluir Webhook

Chame a API com os mesmos parâmetros usados para criar o webhook (target_url, event_type, request_method) para excluí-lo novamente. Alternativamente, você pode excluir um webhook diretamente através do respectivo ID. Para isso, forneça o parâmetro id.

Você receberá o mesmo retorno que ao criar o webhook.

Parâmetros (Excluir por ID)

  • Name
    id
    Type
    integer
    Description

    O ID do webhook que você deseja excluir.

Anfrage

DELETE
/api/hooks
curl -X DELETE "https://gateway.seven.io/api/hooks" \
    -H "X-Api-Key: SUA_CHAVE_API" \
    -d "id=123456"

Antwort

{
    "success": true,
    "code": null,
    "id": 12345,
    "error_message": null
}