Skip to main content
POST
Créer un abonnement webhook pour une entreprise marchande (API Fournisseur de services)

Authorizations

X-API-KEY
string
header
required

Clé API pour les requêtes de l'API Partenaire

Body

application/json

Schéma de requête pour créer un abonnement webhook pour une entreprise marchande

merchantBusinessId
string<uuid>
required

Identifiant de l'entreprise marchande (doit être une entreprise intégrée par le fournisseur de services)

Example:

"59ae202a-f583-4a15-970f-9e99bd1e0baa"

url
string<url>
required

URL HTTPS du webhook

Example:

"https://partner.example.com/webhooks/jeko"

name
string

Nom optionnel pour identifier l'abonnement

Maximum string length: 255
Example:

"Webhook production"

events
enum<string>[]

Événements à recevoir (optionnel — tous les événements si omis)

Événement d'abonnement webhook

Available options:
TRANSACTION_COMPLETED

Response

Abonnement webhook créé avec succès

Abonnement webhook créé — le secret HMAC est retourné une seule fois

id
string<uuid>
required
Example:

"b7e2c1a0-4f3d-4a8e-9c1b-2d5e6f7a8b9c"

url
string<url>
required
Example:

"https://partner.example.com/webhooks/jeko"

businessId
string<uuid>
required
Example:

"59ae202a-f583-4a15-970f-9e99bd1e0baa"

createdAt
string<date-time>
required
Example:

"2024-01-15T14:30:25.000Z"

updatedAt
string<date-time>
required
Example:

"2024-01-15T14:30:25.000Z"

secret
string
required

Secret de signature HMAC. Retourné une seule fois à la création. Stockez-le de manière sécurisée car il ne peut pas être récupéré plus tard.

Example:

"a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456"

name
string | null
Example:

"Webhook production"

events
enum<string>[] | null

Événement d'abonnement webhook

Available options:
TRANSACTION_COMPLETED