S’abonner à des événements

curl --request POST \
--url https://api.arquos.eu/api/v2/webhooks \
--header 'Authorization: Bearer arq_agent_VOTRE_JETON' \
--header 'Content-Type: application/json' \
--data '{
"url": "texte",
"events": [
  "appel.clos"
]
}'

{
"id": "3f1c2b9e-8a4d-4c1e-9b7a-2d5e6f708192",
"secret": "texte"
}

curl --request POST \
--url https://api.arquos.eu/api/v2/webhooks \
--header 'Authorization: Bearer arq_agent_VOTRE_JETON' \
--header 'Content-Type: application/json' \
--data '{
"url": "texte",
"events": [
  "appel.clos"
]
}'

{
"id": "3f1c2b9e-8a4d-4c1e-9b7a-2d5e6f708192",
"secret": "texte"
}

Endpoint & Authentification

Méthode	URL
`POST`	`https://api.arquos.eu/api/v2/webhooks`

En-têtes (Headers) :

Authorization: Bearer [VOTRE_JETON_D_API]
X-Arquos-Agency: [IDENTIFIANT_D_AGENCE] (facultatif, voir Agence)
Content-Type: application/json

Paramètres de la requête

string

L’identifiant de l’agence où agir. Absent : l’agence par défaut du compte. Une agence hors de sa portée est refusée (403).

string

required

L’adresse qui reçoit, en https.

string[]

required

Les événements à recevoir.

Réponse (`201`)

string

L’identifiant Arquos.

string

Le secret qui signe chaque envoi (en-tête X-Arquos-Signature). Il n’est rendu qu’ici, une seule fois.

Les erreurs

Code	Quand
`400`	Requête mal formée ou champ obligatoire manquant.
`401`	Jeton absent, inconnu ou révoqué.
`403`	Agence hors de votre portée.
`404`	Objet introuvable dans vos agences.
`422`	Saisie refusée par Arquos (champ obligatoire, valeur hors bornes, choix inconnu).
`429`	Trop d’appels : réessayez après le délai de l’en-tête Retry-After.

Le corps d’une erreur porte error, sa raison en français. Voir Les erreurs.

curl --request POST \
--url https://api.arquos.eu/api/v2/webhooks \
--header 'Authorization: Bearer arq_agent_VOTRE_JETON' \
--header 'Content-Type: application/json' \
--data '{
"url": "texte",
"events": [
  "appel.clos"
]
}'

{
"id": "3f1c2b9e-8a4d-4c1e-9b7a-2d5e6f708192",
"secret": "texte"
}

Démarrer

API REST

Centres d'appels

Agents IA

Référence · Compte

Référence · Recherche

Référence · Équipements

Référence · Relevés

Référence · Contrats

Référence · Import

Référence · Webhooks

Référence · Référentiels

Référence · Affaires

Référence · Appels

Référence · Visites

Référence · Techniciens

Référence · Pièces

Référence · Devis

Référence · Notes

Référence · Écarts et réserves

Référence · Factures

Référence · Clients

Référence · Immeubles

Référence · Contacts

Référence · Secteurs

Référence · Campagnes

Référence · Contrôles techniques

Référence · Sollicitations

Endpoint & Authentification

Paramètres de la requête

Réponse (`201`)

Les erreurs

​Endpoint & Authentification

​Paramètres de la requête

​Réponse (201)

​Les erreurs

Endpoint & Authentification

Paramètres de la requête

Réponse (`201`)

Les erreurs