List Webhook Endpoints

List webhook endpoints.

Scopes: webhooks:read webhooks:write

GET /v1/webhooks/endpoints

Go (SDK)

Go

package main

import(
	"context"
	"os"
	polargo "github.com/polarsource/polar-go"
	"github.com/polarsource/polar-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := polargo.New(
        polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
    )

    res, err := s.Webhooks.ListWebhookEndpoints(ctx, polargo.Pointer(operations.CreateQueryParamOrganizationIDStr(
        "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
    )), polargo.Pointer[int64](1), polargo.Pointer[int64](10))
    if err != nil {
        log.Fatal(err)
    }
    if res.ListResourceWebhookEndpoint != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}

200

{
  "items": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "url": "<string>",
      "secret": "<string>",
      "organization_id": "<string>",
      "events": [],
      "enabled": true,
      "name": "<string>"
    }
  ],
  "pagination": {
    "total_count": 123,
    "max_page": 123
  }
}

Authorizations

Authorization · string · header · required

You can generate an Organization Access Token from your organization's settings.

Query Parameters

organization_id · string<uuid4> string<uuid4>[]

Filter by organization ID. The organization ID.

Example:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

page · integer · default: 1

Page number, defaults to 1.

limit · integer · default: 10

Size of a page, defaults to 10. Maximum is 100.

Response

200

application/json

Successful Response

items · WebhookEndpoint · object[] · required

Show child attributes

pagination · Pagination · object · required

Show child attributes