Webhook subscriptions
AI agents: read /llms.txt; add .md to any page URL. This page as Markdown: /reference/webhook-subscriptions.md. Index of every page and the rules for every call: /llms.txt. Guides and concepts in one file: /llms-full.txt. OpenAPI: /openapi.json.
Subscribe a URL to YoPrint events, such as a published sales order or a received payment. YoPrint signs every delivery with the subscription's secret, retries failures and keeps a delivery log. The web app calls them Webhooks.
Learn more: Receive webhooks
8 operations
- POSTCreate a webhook subscription
/Subscribes a URL to team events.v1/ api/ store/ {team_slug}/ setting/ webhook_subscription - GETList webhook subscriptions
/Returns the team's webhook subscriptions, one page at a time.v1/ api/ store/ {team_slug}/ setting/ webhook_subscription - GETList deliveries for a webhook subscription
/Returns the subscription's deliveries, newest first, one page at a time.v1/ api/ store/ {team_slug}/ setting/ webhook_subscription/ {id}/ log - GETShow a webhook subscription
/Returns one webhook subscription with itsv1/ api/ store/ {team_slug}/ setting/ webhook_subscription/ {hash_id} statusanddisable_reason, and its signingsecretfor the team owner and members with Manage Settings. - GETShow a sample event
/Builds the event YoPrint would send forv1/ api/ store/ {team_slug}/ setting/ webhook_subscription/ sample/ {event_name} event_name, from your team's latest matching record, without sending anything. - PUTUpdate a webhook subscription
/Changes a subscription's URL, name, events or status, and returns it.v1/ api/ store/ {team_slug}/ setting/ webhook_subscription/ {hash_id} - PATCHTouch a webhook subscription
/Use PUT to change a webhook subscription.v1/ api/ store/ {team_slug}/ setting/ webhook_subscription/ {hash_id} - DELETEDelete a webhook subscription
/Deletes a subscription for good, with its delivery log.v1/ api/ store/ {team_slug}/ setting/ webhook_subscription/ {hash_id}