API de webhooks

Gerencie a configuração de webhooks dos workloads. A entrega dos callbacks do provedor não faz parte desta coleção.

Usar Autenticação da API para pedidos protegidos. Exemplos usam seus próprios IDs de recursos e um token temporário; exemplos de resposta salvos são sintéticos.

Método	Caminho	Operação
GET	/v1/webhook	Listar webhooks
POST	/v1/webhook	Criar webhook
GET	/v1/webhook/{id}	Obter o webhook
PUT	/v1/webhook/{id}	Atualizar o webhook
DELETE	/v1/webhook/{id}	Apagar o webhook

Listar webhooks

GET /v1/webhook

Retorna uma lista paginada de Webhook

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

Nome	Localização	Obrigatório	Descrição
X-Tenant-ID	cabeçalho	sim	ID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.
page	consulta	não	Número da página
per_page	consulta	não	Itens por página

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/webhook" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Resposta: HTTP 200

Lista de Webhook

Campos de resposta

Campo	Tipo	Descrição
data	array
data[].created_at	inteiro	(Timestamp Unix)
data[].deleted_at	inteiro	(Timestamp Unix)
data[].external_id	string	ID externo do provedor (por exemplo, ID do webhook)
data[].provider	string	Valores permitidos: github, bitbucket.
data[].status	string	Valores permitidos: active, inactive.
data[].team_id	string
data[].updated_at	inteiro	(Timestamp Unix)
data[].webhook_id	string
data[].workload_id	string
pagination	objeto
pagination.page	inteiro	Número da página atual
pagination.per_page	inteiro	Número de itens por página
pagination.total	inteiro	Número total de itens

Exemplo ilustrativo; não é uma resposta real:

{
  "data": [
    {
      "created_at": 1791072000,
      "deleted_at": 0,
      "external_id": "example",
      "provider": "github",
      "status": "active",
      "team_id": "000000000000000000000000001",
      "updated_at": 1791072000,
      "webhook_id": "000000000000000000000000001",
      "workload_id": "000000000000000000000000001"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 1,
    "total": 1
  }
}

Criar webhook

POST /v1/webhook

Cria um novo objeto Webhook

Esta requisição altera dados ou inicia uma ação. Confira o destino e o corpo antes de enviá-la.

Campos da requisição (o corpo contém um exemplo editável):

Campo	Tipo	Obrigatório	Descrição
external_id	string	não	ID externo do provedor (por exemplo, ID do webhook)
provider	string	sim	Valores permitidos: github, bitbucket.
status	string	sim	Valores permitidos: active, inactive. Padrão: "active".
team_id	string	sim
workload_id	string	sim

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

Nome	Localização	Obrigatório	Descrição
X-Tenant-ID	cabeçalho	sim	ID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

curl --fail-with-body --request POST "$ADIOS_API_URL/v1/webhook" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "provider": "github",
  "status": "active",
  "team_id": "YOUR_TEAM_ID",
  "workload_id": "YOUR_WORKLOAD_ID"
}
JSON

Substitua YOUR_* no corpo antes de enviar. O heredoc com delimitador entre aspas mantém o JSON literal.

Resposta: HTTP 201

Webhook criado

Campos de resposta

Campo	Tipo	Descrição
created_at	inteiro	(Timestamp Unix)
deleted_at	inteiro	(Timestamp Unix)
external_id	string	ID externo do provedor (por exemplo, ID do webhook)
provider	string	Valores permitidos: github, bitbucket.
status	string	Valores permitidos: active, inactive.
team_id	string
updated_at	inteiro	(Timestamp Unix)
webhook_id	string
workload_id	string

Exemplo ilustrativo; não é uma resposta real:

{
  "created_at": 1791072000,
  "deleted_at": 0,
  "external_id": "example",
  "provider": "github",
  "status": "active",
  "team_id": "000000000000000000000000001",
  "updated_at": 1791072000,
  "webhook_id": "000000000000000000000000001",
  "workload_id": "000000000000000000000000001"
}

Obter o webhook

GET /v1/webhook/{id}

Retorna um objeto Webhook

Defina webhook_id usando IDs das suas próprias respostas da API.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

Nome	Localização	Obrigatório	Descrição
id	caminho	sim	Identificador de recurso dos resultados da API da sua equipe.
X-Tenant-ID	cabeçalho	sim	ID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/webhook/${ADIOS_WEBHOOK_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Resposta: HTTP 200

Webhook

Campos de resposta

Campo	Tipo	Descrição
created_at	inteiro	(Timestamp Unix)
deleted_at	inteiro	(Timestamp Unix)
external_id	string	ID externo do provedor (por exemplo, ID do webhook)
provider	string	Valores permitidos: github, bitbucket.
status	string	Valores permitidos: active, inactive.
team_id	string
updated_at	inteiro	(Timestamp Unix)
webhook_id	string
workload_id	string

Exemplo ilustrativo; não é uma resposta real:

{
  "created_at": 1791072000,
  "deleted_at": 0,
  "external_id": "example",
  "provider": "github",
  "status": "active",
  "team_id": "000000000000000000000000001",
  "updated_at": 1791072000,
  "webhook_id": "000000000000000000000000001",
  "workload_id": "000000000000000000000000001"
}

Atualizar o webhook

PUT /v1/webhook/{id}

Atualiza um objeto Webhook existente

Defina webhook_id usando IDs das suas próprias respostas da API.

Esta requisição altera dados ou inicia uma ação. Confira o destino e o corpo antes de enviá-la.

Campos da requisição (o corpo contém um exemplo editável):

Campo	Tipo	Obrigatório	Descrição
external_id	string	não	ID externo do provedor (por exemplo, ID do webhook)
provider	string	sim	Valores permitidos: github, bitbucket.
status	string	sim	Valores permitidos: active, inactive. Padrão: "active".
team_id	string	sim
workload_id	string	sim

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

Nome	Localização	Obrigatório	Descrição
id	caminho	sim	Identificador de recurso dos resultados da API da sua equipe.
X-Tenant-ID	cabeçalho	sim	ID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

curl --fail-with-body --request PUT "$ADIOS_API_URL/v1/webhook/${ADIOS_WEBHOOK_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "provider": "github",
  "status": "active",
  "team_id": "YOUR_TEAM_ID",
  "workload_id": "YOUR_WORKLOAD_ID"
}
JSON

Substitua YOUR_* no corpo antes de enviar. O heredoc com delimitador entre aspas mantém o JSON literal.

Resposta: HTTP 200

Webhook atualizado

Campos de resposta

Campo	Tipo	Descrição
created_at	inteiro	(Timestamp Unix)
deleted_at	inteiro	(Timestamp Unix)
external_id	string	ID externo do provedor (por exemplo, ID do webhook)
provider	string	Valores permitidos: github, bitbucket.
status	string	Valores permitidos: active, inactive.
team_id	string
updated_at	inteiro	(Timestamp Unix)
webhook_id	string
workload_id	string

Exemplo ilustrativo; não é uma resposta real:

{
  "created_at": 1791072000,
  "deleted_at": 0,
  "external_id": "example",
  "provider": "github",
  "status": "active",
  "team_id": "000000000000000000000000001",
  "updated_at": 1791072000,
  "webhook_id": "000000000000000000000000001",
  "workload_id": "000000000000000000000000001"
}

Apagar o webhook

DELETE /v1/webhook/{id}

Exclui um objeto Webhook

Defina webhook_id usando IDs das suas próprias respostas da API.

Esta requisição altera dados ou inicia uma ação. Confira o destino e o corpo antes de enviá-la.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

Nome	Localização	Obrigatório	Descrição
id	caminho	sim	Identificador de recurso dos resultados da API da sua equipe.
X-Tenant-ID	cabeçalho	sim	ID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

curl --fail-with-body --request DELETE "$ADIOS_API_URL/v1/webhook/${ADIOS_WEBHOOK_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Resposta: HTTP 200

O recurso foi apagado.

Campos de resposta

Campo	Tipo	Descrição
message	string

Exemplo ilustrativo; não é uma resposta real:

{
  "message": "Deleted successfully"
}