Passer au contenu

Get organization webhook

Requête

Returns a specific organization webhook.

Sécurité
Bearer or PersonalAccessToken
Chemin
organizationIdstring, (uuid)obligatoire

Unique identifier of the organization

webhookIdstring, (uuid)obligatoire

Unique identifier of the webhook

GET
/api/v1/organizations/{organizationId}/webhooks/{webhookId}
curl -i -X GET \
  '/api/v1/organizations/{organizationId}/webhooks/{webhookId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Réponses

OK

Corpsapplication/json
idstring, (uuid)obligatoire

The webhook ID.

urlstringobligatoire

The URL receiving the webhook calls.

eventstring(WebhookEventType)obligatoire

Events a webhook can be configured for. Envelope webhooks support every event, organization webhooks only EnvelopeCompleted.

Enum:"EnvelopeSent""EnvelopeCompleted""EnvelopeCanceled""EnvelopeRestarted""EnvelopeDeleted""RecipientCompleted""RecipientRejected""RecipientDelegated"
createdAtstring, (date-time)obligatoire

When the webhook was created.

updatedAtstring, (date-time)obligatoire

When the webhook was last updated.

authenticationobject(WebhookAuthenticationResponse)

Authentication settings of a webhook. Header names are returned as-is, every secret value is obfuscated with asterisks.

Réponse
{ "id": "c2a3b4d5-e6f7-4890-abcd-ef1234567890", "url": "https://example.com/hooks/organization", "event": "EnvelopeCompleted", "createdAt": "2026-10-05T10:30:00+00:00", "updatedAt": "2026-10-05T10:30:00+00:00", "authentication": { "headers": { … }, "clientCertificate": null, "clientKey": null } }