Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

YouSign Webhook API

Webhook subscription; enables real-time notifications about events that happen in your Yousign organization.

YouSign Webhook API is one of 38 APIs that YouSign publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Webhook. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a changelog, rate-limit docs, and 1 JSON Schema.

This API exposes 5 operations across 2 paths, and defines 24 schemas. It is described by OpenAPI 3.0.0, at version 3.0.

Requests are made against 2 base URLs: https://api-sandbox.yousign.app/v3, https://api.yousign.app/v3.

5 operations 2 paths 24 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
3.0
Base URL
https://api.yousign.com/v3
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

YouSign Webhook API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Webhook 5

Webhook subscription; enables real-time notifications about events that happen in your Yousign organization.

GET
/webhooks
List Webhook subscriptions
get-webhooks → 200400401403405429500
POST
/webhooks
Create a Webhook subscription
post-webhooks-subscriptions body → 201400401403404405415429
DELETE
/webhooks/{webhookId}
Delete a Webhook subscription
delete-webhooks-webhookId 1 param → 204400401403404405429500
GET
/webhooks/{webhookId}
Get a Webhook subscription
get-webhooks-webhookId 1 param → 200400401403404405415429
PATCH
/webhooks/{webhookId}
Update a Webhook subscription
patch-webhooks-webhookId 1 param body → 200400401403404405429500

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are WebhookSubscription (12 properties), CreateWebhookSubscription (9 properties), UpdateWebhookSubscription (9 properties), BadRequestResponse (2 properties). Each schema is shown below with its type and property counts.

CreateWebhookSubscription_scopes
Choose between a wildcard symbol to select all scopes or specify a list of specific scopes.
WebhookSubscription_subscribed_events
Choose between a wildcard symbol to select all Workspaces or specify a list of specific Workspace UUIDs.
InternalServerError
object
2 properties 2 required
WebhookSubscription
object
12 properties 12 required
UpdateWebhookSubscription
object
9 properties
TooManyRequestsResponse
object
1 property 1 required
WebhookScopes
array
One or multiple specific scopes to subscribe.
WebhookSubscription_scopes
UnsupportedMediaTypeResponse
object
2 properties 2 required
WebhookSubscribedEvents
array
List of specific webhook events to subscribe to.
CreateWebhookSubscription
object
9 properties 7 required
MethodNotAllowed
object
1 property 1 required
CreateWebhookSubscription_subscribed_events
Select all the events to subscribe to.
NotFoundResponse
object
2 properties 2 required
BadRequestResponse
object
2 properties 2 required
ForbiddenResponse
object
2 properties 2 required
UnauthorizedResponse
object
2 properties 2 required
WebhookWildcardSubscribedEvent
array
Allows you to subscribe to all events currently existing.
WebhookWildcardScope
array
Wildcard scope to subscribe to all scopes.
UUID
string
The unique identifier for a resource.
WebhookWildcardWorkspace
array
Allows you to select all Workspaces.
WebhookSubscription_workspaces
CreateWebhookSubscription_workspaces
Choose between a wildcard symbol to select all Workspaces or specify a list of specific Workspace UUIDs. The association of specific Workspaces with Webhook is…
WebhookWorkspaces
array
List of Workspace UUIDs.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yousign-webhook-api-openapi.yml Raw ↑

Other APIs YouSign publishes across the network.

YouSign Applicant API
YouSign Approver API
YouSign Archive API
YouSign Audit Trail API
YouSign Bank Account Lookup Verification API
YouSign Bank Account Verification API
YouSign Company Verification API
YouSign Consumption API
YouSign Contact API
YouSign Custom Experience API
YouSign Custom Property API
YouSign Deprecated API