Webhooks

Webhooks API

Overview

This API section allows clients to create and manage webhooks, which will notify their systems when a bot interaction is completed.

Get Webhooks

Endpoint

GET https://api.rdentify.com/v1/workspaces/<workspace-id>/webhooks

Retrieve all registered webhooks within a specific workspace.

Response Example

{
    "success": true,
    "code": 200,
    "detail": "Request completed successfully",
    "data": [
        {
            "id": "1d23cb51-ed61-ee11-b002-0022483f1435",
            "url": "https://yourserver.com/endpoint",
            "isActive": true,
            "event": "InteractionCompleted"
        }
    ],
    "meta": null
}

Get Webhook

Endpoint

GET https://api.rdentify.com/v1/workspaces/<workspace-id>/webhooks/<webhook-id>

Retrieve details of a specific webhook by its ID within a specific workspace.

Response Example

{
    "success": true,
    "code": 200,
    "detail": "Request completed successfully",
    "data": {
        "id": "1d23cb51-ed61-ee11-b002-0022483f1435",
        "url": "https://yourserver.com/endpoint",
        "isActive": true,
        "event": "InteractionCompleted"
    },
    "meta": null
}

Create Webhook

Endpoint

POST https://api.rdentify.com/v1/workspaces/<workspace-id>/webhooks

Create a new webhook within a specific workspace.

Request Body Example

{
    "url": "https://yourserver.com/endpoint",
    "secretToken": "<unique-string>", // Unique secret string webhook will use as a URL parameter when making POST request
    "isActive": true // Defaults to false when not provided
}

Response Example

{
    "success": true,
    "code": 200,
    "detail": "Request completed successfully",
    "data": {
        "id": "1d23cb51-ed61-ee11-b002-0022483f1435",
        "url": "https://yourserver.com/endpoint",
        "isActive": true,
        "event": "InteractionCompleted"
    },
    "meta": null
}

Update Webhook

Endpoint

PATCH https://api.rdentify.com/v1/workspaces/<workspace-id>/webhooks/<webhook-id>

Update the active status of a specific webhook within a specific workspace.

Request Body Example

{
    "isActive": true
}

Response Example

{
    "success": true,
    "code": 200,
    "detail": "Request completed successfully",
    "data": {
        "id": "1d23cb51-ed61-ee11-b002-0022483f1435",
        "url": "https://yourserver.com/endpoint",
        "isActive": true,
        "event": "InteractionCompleted"
    },
    "meta": null
}

Delete Webhook

Endpoint

DELETE https://api.rdentify.com/v1/workspaces/<workspace-id>/webhooks/<webhook-id>

Delete a specific webhook by its ID within a specific workspace.

Response Example

{
    "success": true,
    "code": 200,
    "detail": "Request completed successfully",
    "data": null,
    "meta": null
}