Remove a Webhook Endpoint

DELETE 
/v3/webhooks/:webhookId

This endpoint removes an existing webhook endpoint.

Request

Path Parameters

webhookId stringrequired

The unique identifier of the webhook.

Responses

200

The updated list of webhook settings.

application/json

Schema

Schema

_id string

A unique string identifier for the webhook endpoint.

url stringrequired

The URL where the webhook endpoint will send data to.

description string

A human-readable description of the webhook endpoint. This can be used for documentation or additional context.

_createdAt date-time

The date and time when the webhook endpoint was created, formatted as a string in ISO 8601 format.

Example (from schema)

{
  "_id": "string",
  "url": "string",
  "description": "string",
  "_createdAt": "2024-07-29T15:51:28.071Z"
}

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-07-29T15:51:28.071Z",
  "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-07-29T15:51:28.071Z",
  "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-07-29T15:51:28.071Z",
  "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-07-29T15:51:28.071Z",
  "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-07-29T15:51:28.071Z",
  "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-07-29T15:51:28.071Z",
  "status": 0,
  "code": "string",
  "context": {}
}

Loading...