v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Webhooks da Aplicação

Criar webhook de aplicação

Cria uma configuração de webhook para uma aplicação receber notificações sobre eventos de pagamento e mudanças de status de jornada. Suporta vários métodos de autenticação incluindo chave API, autenticação básica e token de portador.

post/open-keys/itp/api/v2/applications/{applicationId}/webhooks

Path parameters

applicationIdstring required

O ID da aplicação. É um número exclusivo que identifica a aplicação.

Request body

endpointBaseUrlstring uri required

URL de destino

Example request

{
  "endpointBaseUrl": "https://itp.com/kong3",
  "authentication": {
    "authType": "bearer_token",
    "data": {
      "name": "<HEADER_NAME>",
      "value": "<VALUE>",
      "token": "<TOKEN>",
      "username": "USERNAME",
      "password": "PASSWORD"
    },
    "add_position": "header"
  }
}

Response

retornou com sucesso.

idstring required

O ID do webhook da aplicação.

createdAtstring required

updatedAtstring required

deletedAtstring required

applicationIdstring required

O ID da aplicação. É um número exclusivo que identifica a aplicação.

endpointBaseUrlstring uri required

URL de destino

Example response

{
  "createdAt": "2024-01-01T20:32:44.581Z",
  "updatedAt": "2024-01-01T20:32:44.581Z",
  "deletedAt": "2024-01-01T20:32:44.581Z",
  "endpointBaseUrl": "https://itp.com/kong3",
  "authentication": {
    "authType": "bearer_token",
    "data": {
      "name": "<HEADER_NAME>",
      "value": "<VALUE>",
      "token": "<TOKEN>",
      "username": "USERNAME",
      "password": "PASSWORD"
    },
    "add_position": "header"
  }
}