Sets or updates the webhook URL for authenticated users. The webhook will receive notifications about task processing events and status updates. This allows you to receive real-time notifications instead of polling the API for status updates.
Endpoint
POST https://data.reviewdata.ai/webhooks/create-webhook/Request Body
Schema
{
"api_key": "string",
"webhook": "string"
}Required Fields
| Field | Type | Required | Description |
|---|---|---|---|
api_key | string | Yes | API key for authentication |
webhook | string | Yes | Webhook URL to receive notifications |
Field Details
- api_key: Your API key for authentication (max length: 128 characters)
- webhook: Valid URL where notifications will be sent (must be a valid URI format)
Webhook Notifications
When configured, your webhook URL will receive POST requests with the following payload structure:
Task Notification
{
"task_id": "90j2m08rNwG5m3dL",
"publisher_key": "maps.google.com",
"foreign_key": "TEST1234567892",
"profile_key": "https://www.google.com/maps/place/Business-Name/...",
"task_status": 200,
"reviews_urls": [
"https://sau-plus-one-reviews.s3.us-west-2.amazonaws.com/90j2m08rNwG5m3dL.jl"
]
}