API des webhooks

Gérez la configuration des webhooks du workload. La réception des callbacks du fournisseur n’est pas couverte par cette collection.

Utiliser Authentification API pour les requêtes protégées. Les exemples utilisent vos propres ID de ressources et un jeton temporaire ; les exemples de réponses enregistrés sont synthétiques.

Méthode	Chemin	Opération
GET	/v1/webhook	Lister les webhooks
POST	/v1/webhook	Créer un webhook
GET	/v1/webhook/{id}	Obtenir le webhook
PUT	/v1/webhook/{id}	Mettre à jour le webhook
DELETE	/v1/webhook/{id}	Supprimer le webhook

Lister les webhooks

GET /v1/webhook

Renvoie une liste paginée de Webhook

Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.

Paramètres

Nom	Emplacement	Requis	Description
X-Tenant-ID	en-tête	oui	ID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic.
page	requête	non	Numéro de page
per_page	requête	non	Éléments par page

Exemple de requête

Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.

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

Réponse : HTTP 200

Liste de Webhook

Champs de réponse

Champ	Type	Description
data	tableau
data[].created_at	entier	(horodatage Unix)
data[].deleted_at	entier	(horodatage Unix)
data[].external_id	chaîne	ID externe chez le fournisseur (par exemple l’ID du webhook)
data[].provider	chaîne	Valeurs autorisées : github, bitbucket.
data[].status	chaîne	Valeurs autorisées : active, inactive.
data[].team_id	chaîne
data[].updated_at	entier	(horodatage Unix)
data[].webhook_id	chaîne
data[].workload_id	chaîne
pagination	objet
pagination.page	entier	Numéro de page actuel
pagination.per_page	entier	Nombre d’éléments par page
pagination.total	entier	Nombre total d’éléments

Exemple illustratif ; il ne s’agit pas d’une réponse réelle :

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

Créer un webhook

POST /v1/webhook

Crée un nouvel objet Webhook

Cette requête modifie des données ou lance une action. Vérifiez la cible et le corps avant de l’envoyer.

Champs de la requête (le corps contient un exemple modifiable) :

Champ	Type	Requis	Description
external_id	chaîne	non	ID externe chez le fournisseur (par exemple l’ID du webhook)
provider	chaîne	oui	Valeurs autorisées : github, bitbucket.
status	chaîne	oui	Valeurs autorisées : active, inactive. Valeur par défaut : "active".
team_id	chaîne	oui
workload_id	chaîne	oui

Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.

Paramètres

Nom	Emplacement	Requis	Description
X-Tenant-ID	en-tête	oui	ID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic.

Exemple de requête

Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.

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

Remplacez YOUR_* du corps avant l’envoi. Le heredoc entre guillemets préserve le JSON littéral.

Réponse : HTTP 201

Webhook créé

Champs de réponse

Champ	Type	Description
created_at	entier	(horodatage Unix)
deleted_at	entier	(horodatage Unix)
external_id	chaîne	ID externe chez le fournisseur (par exemple l’ID du webhook)
provider	chaîne	Valeurs autorisées : github, bitbucket.
status	chaîne	Valeurs autorisées : active, inactive.
team_id	chaîne
updated_at	entier	(horodatage Unix)
webhook_id	chaîne
workload_id	chaîne

Exemple illustratif ; il ne s’agit pas d’une réponse réelle :

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

Obtenir le webhook

GET /v1/webhook/{id}

Renvoie un seul Webhook

Définissez webhook_id en utilisant les ID de vos propres réponses API.

Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.

Paramètres

Nom	Emplacement	Requis	Description
id	chemin	oui	Identifiant de ressource issu des résultats API de votre équipe.
X-Tenant-ID	en-tête	oui	ID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic.

Exemple de requête

Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.

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"

Réponse : HTTP 200

Webhook

Champs de réponse

Champ	Type	Description
created_at	entier	(horodatage Unix)
deleted_at	entier	(horodatage Unix)
external_id	chaîne	ID externe chez le fournisseur (par exemple l’ID du webhook)
provider	chaîne	Valeurs autorisées : github, bitbucket.
status	chaîne	Valeurs autorisées : active, inactive.
team_id	chaîne
updated_at	entier	(horodatage Unix)
webhook_id	chaîne
workload_id	chaîne

Exemple illustratif ; il ne s’agit pas d’une réponse réelle :

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

Mettre à jour le webhook

PUT /v1/webhook/{id}

Met à jour un objet Webhook existant

Définissez webhook_id en utilisant les ID de vos propres réponses API.

Cette requête modifie des données ou lance une action. Vérifiez la cible et le corps avant de l’envoyer.

Champs de la requête (le corps contient un exemple modifiable) :

Champ	Type	Requis	Description
external_id	chaîne	non	ID externe chez le fournisseur (par exemple l’ID du webhook)
provider	chaîne	oui	Valeurs autorisées : github, bitbucket.
status	chaîne	oui	Valeurs autorisées : active, inactive. Valeur par défaut : "active".
team_id	chaîne	oui
workload_id	chaîne	oui

Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.

Paramètres

Nom	Emplacement	Requis	Description
id	chemin	oui	Identifiant de ressource issu des résultats API de votre équipe.
X-Tenant-ID	en-tête	oui	ID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic.

Exemple de requête

Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.

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

Remplacez YOUR_* du corps avant l’envoi. Le heredoc entre guillemets préserve le JSON littéral.

Réponse : HTTP 200

Webhook mis à jour

Champs de réponse

Champ	Type	Description
created_at	entier	(horodatage Unix)
deleted_at	entier	(horodatage Unix)
external_id	chaîne	ID externe chez le fournisseur (par exemple l’ID du webhook)
provider	chaîne	Valeurs autorisées : github, bitbucket.
status	chaîne	Valeurs autorisées : active, inactive.
team_id	chaîne
updated_at	entier	(horodatage Unix)
webhook_id	chaîne
workload_id	chaîne

Exemple illustratif ; il ne s’agit pas d’une réponse réelle :

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

Supprimer le webhook

DELETE /v1/webhook/{id}

Supprime un objet Webhook

Définissez webhook_id en utilisant les ID de vos propres réponses API.

Cette requête modifie des données ou lance une action. Vérifiez la cible et le corps avant de l’envoyer.

Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.

Paramètres

Nom	Emplacement	Requis	Description
id	chemin	oui	Identifiant de ressource issu des résultats API de votre équipe.
X-Tenant-ID	en-tête	oui	ID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic.

Exemple de requête

Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.

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"

Réponse : HTTP 200

Ressource supprimée.

Champs de réponse

Champ	Type	Description
message	chaîne

Exemple illustratif ; il ne s’agit pas d’une réponse réelle :

{
  "message": "Deleted successfully"
}