Skip to main content
PUT
@firma-dev/sdk

Autorisations

Authorization
string
header
requis

Clé API pour l'authentification. Utilisez votre clé API directement sans préfixe (par exemple, 'your-api-key'). Le préfixe Bearer est optionnel mais pas obligatoire.

Paramètres de chemin

id
string<uuid>
requis

Corps

application/json
url
string<uri>
events
enum<string>[]
Options disponibles:
signing_request.created,
signing_request.sent,
signing_request.viewed,
signing_request.completed,
signing_request.declined,
signing_request.cancelled,
signing_request.expired,
signing_request.voided,
signing_request.field.completed,
signing_request.deleted,
signing_request.resent,
signing_request.credits.purchased,
template.created,
template.updated,
template.deleted,
template.field.added,
template.used,
workspace.created,
workspace.updated,
workspace.deleted,
domain.verified,
domain.verification.failed,
organization_seal.created,
organization_seal.updated,
organization_seal.deleted,
organization_seal.erased,
signing_request.seal.applied,
signing_request.seal.paused,
signing_request.seal.swapped

Réponse

Webhook mis à jour avec succès

id
string<uuid>
requis

Identifiant unique du Webhook

url
string<uri>
requis

URL du Webhook

events
string[]
requis

Événements qui déclenchent ce Webhook

enabled
boolean
requis

Indique si le Webhook est activé

created_at
string<date-time>
requis

Horodatage de création du Webhook

description
string | null

Description du Webhook

consecutive_failures
integer

Nombre d'échecs de livraison consécutifs

auto_disabled_at
string<date-time> | null

Horodatage de la désactivation automatique du Webhook suite à des échecs

updated_at
string<date-time>

Horodatage de la dernière mise à jour du Webhook