Skip to main content

Get a Webhook Event

GET 
/v4/webhooks/:webhookId/events/:eventId

This endpoint retrieves a specific webhook event.

Request​

Path Parameters

    webhookId stringrequired

    The unique identifier of the webhook.

    eventId stringrequired

    The unique identifier of the event.

Responses​

The specific webhook event.

Schema

    _id string

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

    appId appId (string)required

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

    appEnv IGNISIGN_APPLICATION_ENV (string)required

    Possible values: [DEVELOPMENT, STAGING, PRODUCTION]

    A reference to the environment settings for the Ignisign application. This includes various configurations specific to the application's environment.

    webhookId stringrequired

    The unique identifier of the webhook associated with this event.

    topic IGNISIGN_WEBHOOK_TOPICS (string)required

    Possible values: [ALL, APP, SIGNATURE, SIGNATURE_REQUEST, SIGNER, 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: [SETTINGS_UPDATED, MEMBERSHIP_UPDATED, ARCHIVED]

    msgNature IGNISIGN_WEBHOOK_MESSAGE_NATURE (string)required

    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_STATUS (string)required

    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.

Loading...