For the complete documentation index, see llms.txt. This page is also available as Markdown.

Manage webhooks

Create webhook

POST /webhooks

This endpoint lets you create a new webhook to track changes to the stock or price of a product.

Headers

Header
Type
Description

Authorization

string

Bearer token.

Request body

{
    "webhookUrl": "https://test.com",
    "webhookType": "stock.alert" //options are stock.alert and price.alert
}

Response

{
    "success": true,
    "message": "Webhook created successfully",
    "data": {
        "id": "69416e629e0508a7d6bb34a0",
        "webhookUrl": "https://test.com",
        "webhookType": "stock.alert",
        "apiKey": "693fc81db7259fa413a3844e",
        "parentId": "69119256f34516a8f3dbc536"
    }
}
{
  "success": false,
  "message": "Validation error",
  "error": "Webhook validation failed: ..."
}
{
  "success": false,
  "message": "Failed to create webhook",
  "error": error message
}

Delete webhook

DEL /webhooks/{webhook_id}

This endpoint lets you delete a webhook.

Headers

Header
Type
Description

Authorization

string

Bearer token.

Response

Last updated