API dei webhook

Gestisci la configurazione dei webhook del carico di lavoro. L’invio dei callback del fornitore non fa parte di questa raccolta.

Usa Autenticazione API per le richieste protette. Gli esempi usano i tuoi ID di risorse e un token temporaneo; gli esempi di risposte salvate sono sintetici.

Metodo	Percorso	Operazione
GET	/v1/webhook	Elenca i webhook
POST	/v1/webhook	Crea webhook
GET	/v1/webhook/{id}	Ottieni webhook
PUT	/v1/webhook/{id}	Aggiorna webhook
DELETE	/v1/webhook/{id}	Elimina webhook

Elenca i webhook

GET /v1/webhook

Restituisce un elenco paginato di Webhook

Autenticazione: token bearer e intestazione del team mostrate di seguito.

Parametri

Nome	Posizione	Obbligatorio	Descrizione
X-Tenant-ID	header	Sì	ID del team attivo. Deve corrispondere al tenant a cui è vincolato il token diagnostico.
page	query	No	Numero di pagina
per_page	query	No	Elementi per pagina

Esempio di richiesta

Imposta ADIOS_API_URL=https://api.adios.dev. Per le richieste protette, imposta ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID come nel guida rapida. Imposta le eventuali variabili aggiuntive ADIOS_* con i valori ottenuti dalle tue risorse.

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

Risposta: HTTP 200

Elenco di Webhook

Campi di risposta

Campo	Tipo	Descrizione
data	array
data[].created_at	integer	(timestamp Unix)
data[].deleted_at	integer	(timestamp Unix)
data[].external_id	string	ID esterno fornito dal servizio (per esempio l’ID del webhook)
data[].provider	string	Valori consentiti: github, bitbucket.
data[].status	string	Valori consentiti: active, inactive.
data[].team_id	string
data[].updated_at	integer	(timestamp Unix)
data[].webhook_id	string
data[].workload_id	string
pagination	object
pagination.page	integer	Numero di pagina attuale
pagination.per_page	integer	Numero di elementi per pagina
pagination.total	integer	Numero totale di elementi

Esempio illustrativo; non è una risposta dal vivo:

{
  "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
  }
}

Crea webhook

POST /v1/webhook

Crea un nuovo oggetto Webhook

Questa richiesta modifica dati o avvia un’azione. Controlla la destinazione e il corpo prima dell’invio.

Campi di richiesta (il corpo contiene un esempio modificabile):

Campo	Tipo	Obbligatorio	Descrizione
external_id	string	No	ID esterno fornito dal servizio (per esempio l’ID del webhook)
provider	string	Sì	Valori consentiti: github, bitbucket.
status	string	Sì	Valori consentiti: active, inactive. Valore predefinito: "active".
team_id	string	Sì
workload_id	string	Sì

Autenticazione: token bearer e intestazione del team mostrate di seguito.

Parametri

Nome	Posizione	Obbligatorio	Descrizione
X-Tenant-ID	header	Sì	ID del team attivo. Deve corrispondere al tenant a cui è vincolato il token diagnostico.

Esempio di richiesta

Imposta ADIOS_API_URL=https://api.adios.dev. Per le richieste protette, imposta ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID come nel guida rapida. Imposta le eventuali variabili aggiuntive ADIOS_* con i valori ottenuti dalle tue risorse.

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

Sostituisci YOUR_* nel corpo prima dell’invio. L’heredoc tra virgolette mantiene il JSON letterale.

Risposta: HTTP 201

Webhook creato

Campi di risposta

Campo	Tipo	Descrizione
created_at	integer	(timestamp Unix)
deleted_at	integer	(timestamp Unix)
external_id	string	ID esterno fornito dal servizio (per esempio l’ID del webhook)
provider	string	Valori consentiti: github, bitbucket.
status	string	Valori consentiti: active, inactive.
team_id	string
updated_at	integer	(timestamp Unix)
webhook_id	string
workload_id	string

Esempio illustrativo; non è una risposta dal vivo:

{
  "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"
}

Ottieni webhook

GET /v1/webhook/{id}

Restituisce un oggetto Webhook

Imposta webhook_id usando gli ID restituiti dalle tue risposte API.

Autenticazione: token bearer e intestazione del team mostrate di seguito.

Parametri

Nome	Posizione	Obbligatorio	Descrizione
id	path	Sì	Identificativo della risorsa ottenuto dai risultati API del tuo team.
X-Tenant-ID	header	Sì	ID del team attivo. Deve corrispondere al tenant a cui è vincolato il token diagnostico.

Esempio di richiesta

Imposta ADIOS_API_URL=https://api.adios.dev. Per le richieste protette, imposta ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID come nel guida rapida. Imposta le eventuali variabili aggiuntive ADIOS_* con i valori ottenuti dalle tue risorse.

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"

Risposta: HTTP 200

Webhook

Campi di risposta

Campo	Tipo	Descrizione
created_at	integer	(timestamp Unix)
deleted_at	integer	(timestamp Unix)
external_id	string	ID esterno fornito dal servizio (per esempio l’ID del webhook)
provider	string	Valori consentiti: github, bitbucket.
status	string	Valori consentiti: active, inactive.
team_id	string
updated_at	integer	(timestamp Unix)
webhook_id	string
workload_id	string

Esempio illustrativo; non è una risposta dal vivo:

{
  "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"
}

Aggiorna webhook

PUT /v1/webhook/{id}

Aggiorna un oggetto Webhook esistente

Imposta webhook_id usando gli ID restituiti dalle tue risposte API.

Questa richiesta modifica dati o avvia un’azione. Controlla la destinazione e il corpo prima dell’invio.

Campi di richiesta (il corpo contiene un esempio modificabile):

Campo	Tipo	Obbligatorio	Descrizione
external_id	string	No	ID esterno fornito dal servizio (per esempio l’ID del webhook)
provider	string	Sì	Valori consentiti: github, bitbucket.
status	string	Sì	Valori consentiti: active, inactive. Valore predefinito: "active".
team_id	string	Sì
workload_id	string	Sì

Autenticazione: token bearer e intestazione del team mostrate di seguito.

Parametri

Nome	Posizione	Obbligatorio	Descrizione
id	path	Sì	Identificativo della risorsa ottenuto dai risultati API del tuo team.
X-Tenant-ID	header	Sì	ID del team attivo. Deve corrispondere al tenant a cui è vincolato il token diagnostico.

Esempio di richiesta

Imposta ADIOS_API_URL=https://api.adios.dev. Per le richieste protette, imposta ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID come nel guida rapida. Imposta le eventuali variabili aggiuntive ADIOS_* con i valori ottenuti dalle tue risorse.

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

Sostituisci YOUR_* nel corpo prima dell’invio. L’heredoc tra virgolette mantiene il JSON letterale.

Risposta: HTTP 200

Webhook aggiornato

Campi di risposta

Campo	Tipo	Descrizione
created_at	integer	(timestamp Unix)
deleted_at	integer	(timestamp Unix)
external_id	string	ID esterno fornito dal servizio (per esempio l’ID del webhook)
provider	string	Valori consentiti: github, bitbucket.
status	string	Valori consentiti: active, inactive.
team_id	string
updated_at	integer	(timestamp Unix)
webhook_id	string
workload_id	string

Esempio illustrativo; non è una risposta dal vivo:

{
  "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"
}

Elimina webhook

DELETE /v1/webhook/{id}

Elimina un oggetto Webhook

Imposta webhook_id usando gli ID restituiti dalle tue risposte API.

Questa richiesta modifica dati o avvia un’azione. Controlla la destinazione e il corpo prima dell’invio.

Autenticazione: token bearer e intestazione del team mostrate di seguito.

Parametri

Nome	Posizione	Obbligatorio	Descrizione
id	path	Sì	Identificativo della risorsa ottenuto dai risultati API del tuo team.
X-Tenant-ID	header	Sì	ID del team attivo. Deve corrispondere al tenant a cui è vincolato il token diagnostico.

Esempio di richiesta

Imposta ADIOS_API_URL=https://api.adios.dev. Per le richieste protette, imposta ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID come nel guida rapida. Imposta le eventuali variabili aggiuntive ADIOS_* con i valori ottenuti dalle tue risorse.

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"

Risposta: HTTP 200

Risorsa eliminata.

Campi di risposta

Campo	Tipo	Descrizione
message	string

Esempio illustrativo; non è una risposta dal vivo:

{
  "message": "Deleted successfully"
}