Skip to main content
POST
/
webhooks
Create webhook subscription
curl --request POST \
  --url https://api.app.hrizn.io/v1/public/webhooks \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "url": "<string>",
  "events": [
    "ideacloud.completed"
  ]
}
'
{
  "data": {
    "id": "008ca3b4-3e47-48bd-89d0-cd3d46689f30",
    "url": "https://webhook.site/test-endpoint",
    "events": [
      "content.completed",
      "ideacloud.completed"
    ],
    "secret": "c7788a44ceaa36581f2d11be7efca748cfe10389310c762888242be609372395",
    "is_active": true,
    "created_at": "2026-02-28T11:46:25.244782+00:00"
  }
}
Subscribe to events by providing a URL that will receive POST requests when events occur. Each webhook is signed with HMAC-SHA256 for verification. Scope required: webhooks:write

​
Request body

​
url
string
required
HTTPS endpoint URL that will receive webhook payloads.
​
events
array
required
List of event types to subscribe to. See Webhook events for all options.
​
description
string
Optional description for this subscription.

​
Response

Returns the subscription details including the signing secret. Save this secret - it is only shown once. 
{
  "data": {
    "id": "008ca3b4-3e47-48bd-89d0-cd3d46689f30",
    "url": "https://webhook.site/test-endpoint",
    "events": [
      "content.completed",
      "ideacloud.completed"
    ],
    "secret": "c7788a44ceaa36581f2d11be7efca748cfe10389310c762888242be609372395",
    "is_active": true,
    "created_at": "2026-02-28T11:46:25.244782+00:00"
  }
}
Save the secret value immediately. It is only returned when the webhook is created and cannot be retrieved later. You will need it to verify incoming webhook signatures.

Authorizations

​
X-API-Key
string
header
required

Your Hrizn API key (prefix hzk_)

Body

application/json
​
url
string<uri>
required

HTTPS URL to receive webhooks

​
events
enum<string>[]
required
Minimum array length: 1
Available options:
ideacloud.completed,
ideacloud.failed,
content.progress,
content.completed,
content.failed,
content.approval.submitted,
content.approval.approved,
content.approval.rejected,
content.approval.escalated,
content.approval.overridden,
compliance.completed,
content_tools.completed,
inventory.description.completed,
inventory.description.batch_completed,
inventory.feed.updated

Response

Webhook created

​
data
object
Last modified on March 1, 2026