Get Webhook Events
GET/v3/webhooks/:webhookId/events
This endpoint retrieves webhook events for a specific webhook.
Request
Path Parameters
The unique identifier of the webhook.
Query Parameters
Possible values: [ALL
, SUCCESS
, FAILED
]
Responses
- 200
- 400
- 401
- 403
- 404
- 408
- 500
The list of webhook events.
- application/json
- Schema
- Example (from schema)
Schema
Array [
- IGNISIGN_WEBHOOK_ACTION_SIGNATURE_REQUEST
- IGNISIGN_WEBHOOK_ACTION_SIGNATURE_SESSION
- IGNISIGN_WEBHOOK_ACTION_SIGNATURE
- IGNISIGN_WEBHOOK_ACTION_SIGNER
- IGNISIGN_WEBHOOK_ACTION_DOCUMENT_REQUEST
- IGNISIGN_WEBHOOK_ACTION_SIGNATURE_IMAGE
- IGNISIGN_WEBHOOK_ACTION_SIGNATURE_PROFILE
- IGNISIGN_WEBHOOK_ACTION_SIGNATURE_PROOF
- IGNISIGN_WEBHOOK_ACTION_APPLICATION
- IGNISIGN_WEBHOOK_ACTION_ALL
]
events
object[]
required
An array of events data represented by the IgnisignWebhookEvent schema.
A unique string identifier for the webhook event. This is typically generated by the system and is read-only.
The application identifier which is used to identify the application used.
Possible values: [DEVELOPMENT
, STAGING
, PRODUCTION
]
The execution environment of the application where request are executed.
The unique identifier of the webhook associated with this event.
Possible values: [ALL
, APP
, SIGNATURE
, SIGNATURE_REQUEST
, SIGNER
, DOCUMENT_REQUEST
, SIGNATURE_PROFILE
, SIGNATURE_SESSION
, SIGNATURE_PROOF
, SIGNATURE_SIGNER_IMAGE
, ID_PROOFING
, SIGNER_AUTH
]
A reference to the topic related to this event.
action
object
required
The action taken that initiated this event.
anyOf
string
Possible values: [INITIALIZED
, UPDATED
, READY
, WAITING_DOCUMENTS
, LAUNCHED
, CANCELLED
, EXPIRED
, COMPLETED
]
string
Possible values: [INITIALIZED
]
string
Possible values: [FINALIZED
, FAILED
]
string
Possible values: [CREATED
, INPUTS_ADDED
]
string
Possible values: [PROVIDED
]
string
Possible values: [GENERATED
]
string
Possible values: [CREATED
, ARCHIVED
]
string
Possible values: [GENERATED
, ADV_GENERATED
]
string
Possible values: [SETTINGS_UPDATED
, MEMBERSHIP_UPDATED
, ARCHIVED
]
string
Possible values: [ALL
]
Possible values: [INFO
, SUCCESS
, WARNING
, ERROR
]
A reference to the nature or type of the message associated with this event.
The content of the webhook event. The structure of this object can vary depending on the nature of the event.
An object containing information about the error that occurred, if any.
response
object
An object containing information about the HTTP response for this event.
The HTTP status code of the response.
The text description of the HTTP status.
Possible values: [SUCCESS
, PENDING
, FAILED
]
A reference to the current status of the event.
The date and time when the webhook event was created, formatted as a string in ISO 8601 format.
searchData
object
required
An object containing pagination information for the events data.
The total number of events available.
The current page number in the context of pagination.
The number of events displayed per page.
{
"events": [
{
"_id": "string",
"appId": "appId_XXXX-XXXX-XXXX-XXXX-XXXX",
"appEnv": "DEVELOPMENT",
"webhookId": "string",
"topic": "ALL",
"action": "INITIALIZED",
"msgNature": "INFO",
"content": {},
"error": {},
"response": {
"status": 0,
"statusText": "string"
},
"status": "SUCCESS",
"_createdAt": "2024-07-29T15:51:28.071Z"
}
],
"searchData": {
"total": 0,
"page": 0,
"nbEventsPerPage": 0
}
}
Bad request error
- application/json
- Schema
- Example (from schema)
Schema
The main message related to the error. It should provide an explanation or additional information about the error.
The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.
The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.
The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).
Additional contextual information related to the error. This object can contain any relevant properties.
{
"message": "string",
"timestamp": "2024-07-29T15:51:28.071Z",
"status": 0,
"code": "string",
"context": {}
}
Unauthorized error
- application/json
- Schema
- Example (from schema)
Schema
The main message related to the error. It should provide an explanation or additional information about the error.
The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.
The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.
The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).
Additional contextual information related to the error. This object can contain any relevant properties.
{
"message": "string",
"timestamp": "2024-07-29T15:51:28.071Z",
"status": 0,
"code": "string",
"context": {}
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
The main message related to the error. It should provide an explanation or additional information about the error.
The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.
The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.
The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).
Additional contextual information related to the error. This object can contain any relevant properties.
{
"message": "string",
"timestamp": "2024-07-29T15:51:28.071Z",
"status": 0,
"code": "string",
"context": {}
}
Not Found
- application/json
- Schema
- Example (from schema)
Schema
The main message related to the error. It should provide an explanation or additional information about the error.
The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.
The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.
The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).
Additional contextual information related to the error. This object can contain any relevant properties.
{
"message": "string",
"timestamp": "2024-07-29T15:51:28.071Z",
"status": 0,
"code": "string",
"context": {}
}
Timeout
- application/json
- Schema
- Example (from schema)
Schema
The main message related to the error. It should provide an explanation or additional information about the error.
The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.
The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.
The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).
Additional contextual information related to the error. This object can contain any relevant properties.
{
"message": "string",
"timestamp": "2024-07-29T15:51:28.071Z",
"status": 0,
"code": "string",
"context": {}
}
Internal Error
- application/json
- Schema
- Example (from schema)
Schema
The main message related to the error. It should provide an explanation or additional information about the error.
The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.
The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.
The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).
Additional contextual information related to the error. This object can contain any relevant properties.
{
"message": "string",
"timestamp": "2024-07-29T15:51:28.071Z",
"status": 0,
"code": "string",
"context": {}
}