Get Webhook Events

GET 
/v3/webhooks/:webhookId/events

This endpoint retrieves webhook events for a specific webhook.

Request

Path Parameters

webhookId stringrequired

The unique identifier of the webhook.

Query Parameters

filter IGNISIGN_WEBHOOK_EVENT_FILTER

Possible values: [ALL, SUCCESS, FAILED]

page integer

Responses

200

The list of webhook events.

application/json

Schema

Schema

events

object[]

required

An array of events data represented by the IgnisignWebhookEvent schema.

Array [

_id string

A unique string identifier for the webhook event. This is typically generated by the system and is read-only.

appId appIdrequired

The application identifier which is used to identify the application used.

appEnv IGNISIGN_APPLICATION_ENVrequired

Possible values: [DEVELOPMENT, STAGING, PRODUCTION]

The execution environment of the application where request are executed.

webhookId stringrequired

The unique identifier of the webhook associated with this event.

topic IGNISIGN_WEBHOOK_TOPICSrequired

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

IGNISIGN_WEBHOOK_ACTION_SIGNATURE_REQUEST

string

IGNISIGN_WEBHOOK_ACTION_SIGNATURE_SESSION

string

IGNISIGN_WEBHOOK_ACTION_SIGNATURE

string

IGNISIGN_WEBHOOK_ACTION_SIGNER

string

IGNISIGN_WEBHOOK_ACTION_DOCUMENT_REQUEST

string

IGNISIGN_WEBHOOK_ACTION_SIGNATURE_IMAGE

string

IGNISIGN_WEBHOOK_ACTION_SIGNATURE_PROFILE

string

IGNISIGN_WEBHOOK_ACTION_SIGNATURE_PROOF

string

IGNISIGN_WEBHOOK_ACTION_APPLICATION

string

IGNISIGN_WEBHOOK_ACTION_ALL

string

msgNature IGNISIGN_WEBHOOK_MESSAGE_NATURErequired

Possible values: [INFO, SUCCESS, WARNING, ERROR]

A reference to the nature or type of the message associated with this event.

content objectrequired

The content of the webhook event. The structure of this object can vary depending on the nature of the event.

error object

An object containing information about the error that occurred, if any.

response

object

An object containing information about the HTTP response for this event.

status number

The HTTP status code of the response.

statusText string

The text description of the HTTP status.

status IGNISIGN_WEBHOOK_EVENT_STATUSrequired

Possible values: [SUCCESS, PENDING, FAILED]

A reference to the current status of the event.

_createdAt date-time

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.

total numberrequired

The total number of events available.

page numberrequired

The current page number in the context of pagination.

nbEventsPerPage numberrequired

The number of events displayed per page.

Example (from schema)

{
  "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-06-14T12:34:38.191Z"
    }
  ],
  "searchData": {
    "total": 0,
    "page": 0,
    "nbEventsPerPage": 0
  }
}

400

Bad request error

application/json

Schema

Schema

message stringrequired

The main message related to the error. It should provide an explanation or additional information about the error.

timestamp date-timerequired

The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.

status integerrequired

The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.

code stringrequired

The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).

context object

Additional contextual information related to the error. This object can contain any relevant properties.

Example (from schema)

{
  "message": "string",
  "timestamp": "2024-06-14T12:34:38.191Z",
  "status": 0,
  "code": "string",
  "context": {}
}

401

Unauthorized error

application/json

Schema

Schema

message stringrequired

The main message related to the error. It should provide an explanation or additional information about the error.

timestamp date-timerequired

The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.

status integerrequired

The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.

code stringrequired

The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).

context object

Additional contextual information related to the error. This object can contain any relevant properties.

Example (from schema)

{
  "message": "string",
  "timestamp": "2024-06-14T12:34:38.191Z",
  "status": 0,
  "code": "string",
  "context": {}
}

403

Forbidden

application/json

Schema

Schema

message stringrequired

The main message related to the error. It should provide an explanation or additional information about the error.

timestamp date-timerequired

The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.

status integerrequired

The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.

code stringrequired

The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).

context object

Additional contextual information related to the error. This object can contain any relevant properties.

Example (from schema)

{
  "message": "string",
  "timestamp": "2024-06-14T12:34:38.192Z",
  "status": 0,
  "code": "string",
  "context": {}
}

404

Not Found

application/json

Schema

Schema

message stringrequired

The main message related to the error. It should provide an explanation or additional information about the error.

timestamp date-timerequired

The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.

status integerrequired

The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.

code stringrequired

The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).

context object

Additional contextual information related to the error. This object can contain any relevant properties.

Example (from schema)

{
  "message": "string",
  "timestamp": "2024-06-14T12:34:38.192Z",
  "status": 0,
  "code": "string",
  "context": {}
}

408

Timeout

application/json

Schema

Schema

message stringrequired

The main message related to the error. It should provide an explanation or additional information about the error.

timestamp date-timerequired

The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.

status integerrequired

The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.

code stringrequired

The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).

context object

Additional contextual information related to the error. This object can contain any relevant properties.

Example (from schema)

{
  "message": "string",
  "timestamp": "2024-06-14T12:34:38.192Z",
  "status": 0,
  "code": "string",
  "context": {}
}

500

Internal Error

application/json

Schema

Schema

message stringrequired

The main message related to the error. It should provide an explanation or additional information about the error.

timestamp date-timerequired

The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.

status integerrequired

The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.

code stringrequired

The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).

context object

Additional contextual information related to the error. This object can contain any relevant properties.

Example (from schema)

{
  "message": "string",
  "timestamp": "2024-06-14T12:34:38.192Z",
  "status": 0,
  "code": "string",
  "context": {}
}

Loading...