Delete Registered API Webhook
This endpoint deletes your registered webhook endpoint.
Endpoint
DELETE /api.ezyhire.com/test/deleteRegisterAPIWebhook/{eventType}Headers
| Header | Type | Required | Description |
|---|---|---|---|
USER-Key | string | Yes | Your API authentication key |
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
eventType | enum | Yes | Type of event to delete webhook for - TEST_COMPLETED, ID_VERIFICATION_COMPLETED, BGV_COMPLETED, BGV_NEEDINFO |
Responses
Success Response
Status Code: 200 OK
{
"statusCode": 200,
"error": "Registered API Webhook deleted successfully.",
"message": null,
"data": null
}Error Responses
Unauthorized
Status Code: 401 Unauthorized
{
"statusCode": 401,
"error": null,
"message": "Invalid User/API key",
"data": "Please provide a valid User/API key"
}Not Found
Status Code: 404 Not Found
{
"statusCode": 404,
"error": "No Registered API Webhook exists with this employer 06e782da-0c98-48ce-a1b0-5d253ddede34, for an event : TEST_COMPLETED",
"message": null,
"data": null
}Internal Server Error
Status Code: 500 Internal Server Error
{
"statusCode": 500,
"error": "string",
"message": "string",
"data": "string"
}Enum Values
| Field Name | Possible Values |
|---|---|
eventType | TEST_COMPLETED, ID_VERIFICATION_COMPLETED, BGV_COMPLETED, BGV_NEEDINFO |
Example Usage
const eventType = "TEST_COMPLETED";
const response = await fetch(`https://api.ezyhire.com/test/deleteRegisterAPIWebhook/${eventType}`, {
method: 'DELETE',
headers: {
'USER-Key': 'your-api-key-here'
}
});
const data = await response.json();