Get list of subscriptions | Fynapse Documentation

curl -G https://api.fynapse.com/api/v1/event-deliveries/subscriptions \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d eventType=user.signup \
     -d isActive=true \
     -d page=0 \
     -d size=100

{
  "items": [
    {
      "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "name": "UserSignupWebhook",
      "endpointUrl": "https://webhooks.example.com/user-signup",
      "secretRef": "user-signup-secret",
      "eventTypes": [
        "user.signup",
        "user.verification"
      ],
      "isActive": true,
      "description": "Webhook subscription for user signup and verification events",
      "createdTime": "2024-01-15T09:30:00Z",
      "updatedTime": "2024-04-10T12:00:00Z",
      "createdBy": "admin_user",
      "updatedBy": "admin_user",
      "secretValue": null
    }
  ],
  "totalPages": 1,
  "totalSize": 1
}

This endpoint returns a paginated list of subscriptions.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

isActiveboolean or nullOptional

eventTypestring or nullOptional

pageintegerRequiredDefaults to 0

sizeintegerRequired<=10000Defaults to 100

Response

Successfully retrieved list

itemslist of objectsOptional

List of items on current page

totalPagesintegerOptional

Total number of pages

totalSizelongOptional

Total number of items

Errors

401

Unauthorized Error

429

Too Many Requests Error

5XX

Server Error