List webhook subscriptions

GET/v1/api/store/{team_slug}/setting/webhook_subscription

v1Operation ID v1_public_webhook_subscription_index

Returns the team's webhook subscriptions, one page at a time. The team owner and members with Manage Settings also get each one's signing secret.

The list includes subscriptions made in the web app (Settings, Webhooks) and by YoPrint's Zapier app (source zapier). It doesn't include the status filters (config) a subscription was created with.

Permission

Any team member can call it. Reading needs no extra permission. Every member sees each subscription's full URL, but only the team owner and members with Manage Settings get its signing secret; for other members it is null. (AI apps connected through YoPrint's MCP server get secret: null and only the URL's scheme and host to protect webhook secrets.)

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team

Query parameters

• pageinteger

  The page to return. A page holds the team's page size (50 unless the team changed it). per_page is not read.

  • Default 1
  • Minimum 1
  • Example 1

Request body

This operation takes no request body.

Response

200Successful response.

• dataarray of objectsrequired
  Fields of each item (10)

  • created_atstring (date-time)required
  • disable_reasonstring | nullrequired

    auto_disable_too_many_errors when YoPrint turned the subscription off because its deliveries kept failing. Otherwise null. Setting status back to active does not clear it.

  • enabled_eventsarray of stringsrequired

    Subscribed event names, or all for every event.

  • idstringrequired

    The subscription id.

  • namestringrequired
  • secretstring | nullrequired

    The secret used to sign event payloads: whsec_ followed by 32 letters and digits. Use it to verify incoming messages. YoPrint creates it when the subscription is created and never changes it. Keep it private. Only the team owner and members whose permission group has Manage Settings can see it; for every other member it is null. It is also null for AI apps reading through YoPrint's MCP server.

  • sourcestringrequired

    The source sent when the subscription was created: the web app sends yoprint, YoPrint's Zapier app sends zapier.

  • statusstringrequired

    Only active subscriptions receive events.

    • One of: "active", "disabled"
  • updated_atstring (date-time)required
  • urlstring | nullrequired

    The destination URL where YoPrint delivers events. On this API, this is the full URL. AI apps reading subscriptions through YoPrint's MCP server see only the origin (scheme and host, such as https://example.com) to protect webhook secrets.

• statusintegerrequired
• successbooleanrequired
• paginationobject
  Child fields (6)

  • countintegerrequired
  • currentPageintegerrequired
  • linksobject | array of anyrequired

    Links to the neighbouring pages: previous and next, each present only when that page exists. An empty list, [], when there is only one page.

    Child fields (2)

    • nextstring (uri)

      The next page.

    • previousstring (uri)

      The previous page.

  • perPageintegerrequired
  • totalintegerrequired
  • totalPagesintegerrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

Notes

• Manage subscriptions with source zapier in Zapier: turning a Zap off deletes its subscription. Deleting one here stops that Zap's events.

Related

• POSTCreate a webhook subscription/v1/api/store/{team_slug}/setting/webhook_subscription
• GETShow a webhook subscription/v1/api/store/{team_slug}/setting/webhook_subscription/{hash_id}
• GETList deliveries for a webhook subscription/v1/api/store/{team_slug}/setting/webhook_subscription/{id}/log

Example request

curl

curl 'https://secure.yoprint.com/v1/api/store/your-team/setting/webhook_subscription' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

Response

{
  "data": [
    {
      "created_at": "2026-11-03T15:00:00+00:00",
      "disable_reason": null,
      "enabled_events": [
        "order.created",
        "payment_received.any_amount"
      ],
      "id": "V4keXwwxMQyXw7",
      "name": "Order sync",
      "secret": "whsec_YOUR_WEBHOOK_SECRET",
      "source": "yoprint",
      "status": "active",
      "updated_at": "2026-11-03T15:00:00+00:00",
      "url": "https://example.com/yoprint/webhooks"
    }
  ],
  "pagination": {
    "count": 1,
    "currentPage": 1,
    "links": [],
    "perPage": 50,
    "total": 1,
    "totalPages": 1
  },
  "status": 200,
  "success": true
}