Get sample webhook payloads from recent comments
Builds sample webhook payloads from the workspace's newest comments, in exactly the shape a live delivery has, so you can map fields before any event fires. These are not replayed deliveries: event_id is sample:<comment id>, occurred_at is the comment's creation time, source is app, and changed is only filled (with a representative status change) when event is comment.status_changed. Requires the read scope.
Request
- Base URL: https://app.huddlekit.com/api/v1
- URL: https://app.huddlekit.com/api/v1/events/recent
- Auth: HTTP bearer
Query parameters
comment.created: a comment was added. comment.status_changed: its status changed. comment.text_changed: its text was edited. comment.screenshot_ready: its screenshot finished capturing (website and webapp comments only). The Send test event button in the Huddlekit app also sends ping, with a made-up comment and no source or permalink; answer it with any 2xx and don't treat it as a real event.
Event type to render the samples as. Defaults to comment.created.
What a comment is attached to. website: a website project (the parent is a project). webapp: a web app that runs the Huddlekit SDK widget (the parent is a web app). document: an uploaded PDF, image or video (the parent is a document).
Only use comments from this surface. Omit to use all surfaces.
Number of samples, 1 to 25. Defaults to 3. Out-of-range values are clamped.
Response
Sample payloads.
Changes
No recorded changes to this operation across all 1 revision of this API.