Body
application/json
Webhook payload
Response
200
Return a 200 OK to indiate that the payload has been successfully received.
Any other response will cause the webhook to retry up to 5 times, over a period of several hours (TODO)
Alpha Release: The Admin API and its documentation are currently in alpha and subject to change. Features, endpoints, and functionality may be modified or updated without notice.
{
"event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"event_timestamp": "<string>",
"payload": {
"id": "1234",
"created_at": "2025-11-07T23:17:23+00:00",
"updated_at": "2025-11-07T23:17:23+00:00",
"targetable_id": 123,
"targetable_type": "<string>",
"text": "<string>",
"replyable": true,
"depth": 123,
"cheer_count": 123,
"reply_count": 123,
"reply_to_id": 123,
"author_id": 123,
"space_id": 123,
"files": [
{
"id": "1234",
"url": "<string>",
"type": "<string>",
"name": "<string>"
}
],
"embedded_link": {
"id": "1234",
"url": "<string>",
"title": "<string>",
"description": "<string>",
"favicon_url": "<string>"
},
"permalink": "<string>"
}
}Triggered when a comment is created by a user, on a post or other commentable content.
{
"event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"event_timestamp": "<string>",
"payload": {
"id": "1234",
"created_at": "2025-11-07T23:17:23+00:00",
"updated_at": "2025-11-07T23:17:23+00:00",
"targetable_id": 123,
"targetable_type": "<string>",
"text": "<string>",
"replyable": true,
"depth": 123,
"cheer_count": 123,
"reply_count": 123,
"reply_to_id": 123,
"author_id": 123,
"space_id": 123,
"files": [
{
"id": "1234",
"url": "<string>",
"type": "<string>",
"name": "<string>"
}
],
"embedded_link": {
"id": "1234",
"url": "<string>",
"title": "<string>",
"description": "<string>",
"favicon_url": "<string>"
},
"permalink": "<string>"
}
}Webhook payload
Return a 200 OK to indiate that the payload has been successfully received.
Any other response will cause the webhook to retry up to 5 times, over a period of several hours (TODO)