Webhooks
Des webhooks sont disponibles sur l'API Creads Partners. Il vous permetteront d'être notifié des changements et évènements qui opèrent au sein de votre Organisation.
Activer les webhooks
Pour activer les webhooks, il vous faut
- Un compte developer (contactez notre support pour activer cette option).
- Ajouter un nouveau webhook dans le menu Developer de l'application Creads Partners
- Un serveur qui répond à l'url que vous avez renseignée dans l'interface Developer
Erreurs
En cas d'erreur sur un de vos webhooks (erreur HTTP ou bien échec de connexion), nous retenterons de vous notifier plusieurs fois.
Si trop d'échecs successifs se produisent, le webhook sera désactivé le temps que vous régliez le problème, et vous serez notifiés par email du problème.
Évènements
Les notifications webhooks qui sont envoyées suivent un schéma d'évènements se constituant comme ceci:
| Attribut | Description |
|---|---|
event |
Le type d'évènement déclenché (création, mise à jour, suppression) |
resource_type |
Le type de la ressource concernée |
resource_gid |
Le gid de la ressource concernée |
resource |
La ressource dans son nouvel état (absent dans le cas de la suppression) |
Les type d'évènements possibles sont les suivants
| Type | Description |
|---|---|
resource.created |
La ressource vient d'être créée. |
resource.updated |
La ressource a subie des modifications |
resource.deleted |
La ressource a été supprimée |
Évènements disponibles
Voici une liste à date des évènements webhooks qui sont disponibles, par ressource:
Invitation
resource.createdresource.updatedresource.deleted
Organization
resource.updated
Product
resource.updated
Membership
resource.createdresource.updatedresource.deleted
Project
resource.createdresource.updatedresource.deleted
Project Message
resource.created
Work
resource.created
Webhook
resource.createdresource.updatedresource.deleted
Sécuriser les webhooks
Tous les appels fait à vos webhooks sont accompagnés d'une signature présente dans le header HTTP X-Partners-Signature.
Nous vous recommandons de vérifier la validité de cette signature afin de vous assurer de l'intégrité et de l'origine de la requête.
La signature est un hash sha256 du body (en JSON) de la requête et de votre clé secrète fournie à la création du webhook.
Pour vérifier sa validité, il vous faut donc
- Votre clé secrète de webhook
- Le body JSON de la requête tel qu'il est reçu
- Générer un hash du body par la clé secrète avec l'algorithme
sha256 - Comparer le header envoyé avec votre résultat
Par exemple, en php, vous obtiendrez le hash en faisant
$expectedSignature = hash_hmac('sha256', $jsonBodyString, 'your_secret_key');