Meet the new Scripe, live on October 7.Register

OpenAPI reference · Webhooks

List webhook endpoints

GET/webhook-endpoints

Returns every webhook endpoint registered for the workspace, ordered by createdAt descending. The plaintext signing secret is never returned by this endpoint — only secretLast4. Use POST /v1/webhook-endpoints/{endpointId}/rotate-secret if the plaintext is lost.

Authorization

  • Authorizationstringrequired

    Bearer token in the Authorization header.

    Pass Authorization: Bearer scripe_sk_live_<...> (or scripe_sk_test_<...> for test keys) on every request. Keys are scoped to a single workspace and can be revoked from the Scripe dashboard.

    The same header also accepts an OAuth 2.1 access token (scripe_oat_*); both credentials share one scope vocabulary and every operation below documents the scope it requires. An API key can hold every scope named on this surface except webhooks:manage, which is grantable to OAuth tokens only today — the webhook-endpoint operations answer 403 scope_missing to every API key. Operations that name no scope accept any valid token of the workspace.

Query parameters

  • limitinteger

    Page size. Default 50, max 200. Values above the max are clamped silently; only a non-integer or a value below 1 is rejected with bad_pagination.

    Default: 50

  • cursorstring

Header parameters

  • Scripe-Api-Versionstring

    Pin the API version. Format YYYY-MM-DD. Omit to receive the currently rolling default. Unknown versions return 400 version_unsupported.

Responses

  • 200

    Paginated list of endpoints.

  • 401

    Missing, malformed, expired, or revoked API key.

  • 403

    Plan not eligible, scope missing, or workspace mismatch.

  • 429

    Sliding-window rate limit exceeded.

Example request

bash
curl --request GET \
  --url 'https://api.scripe.io/v1/webhook-endpoints' \
  --header 'Authorization: Bearer <token>'

Example response (200)

json
{
  "data": [
    {
      "id": "whe_a1b2c3d4e5f6g7h8",
      "url": "https://hooks.example.com/scripe",
      "name": "Production CRM",
      "events": [
        "post.created",
        "job.completed"
      ],
      "isActive": true,
      "disabledReason": "string",
      "projectId": "string",
      "secretLast4": "string",
      "createdAt": "2026-08-10T09:00:00Z",
      "updatedAt": "2026-08-10T09:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "string",
    "has_more": true,
    "total": 128
  }
}