Get webhook event catalogue

GET /webhook-subscriptions/events

Requires webhooks:read, public API access and webhook access for the organisation.

Authorization

X-API-Key required

Returns the complete supported event list, resource groups and sample data for each event. Samples are synthetic examples, not organisation records. The catalogue is not paginated.

Request Examples

curl -X GET "https://api.remypass.com/api/v1/public/webhook-subscriptions/events" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

Responses

Status	Description
200	Success
400	Bad request. The top-level message explains what is invalid and, where applicable, the errors array contains structured field details.
401	Missing or invalid API key.
403	The caller is not allowed to access this resource.
429	Rate limit exceeded.
500	Server error.

200 Response Example

{
  "success": true,
  "message": "Success",
  "data": {
    "groups": {
      "scan": [
        "created"
      ],
      "member": [
        "created",
        "updated",
        "status_changed",
        "deleted"
      ],
      "membership": [
        "created",
        "updated",
        "activated",
        "renewed",
        "expiring",
        "expired",
        "cancellation_scheduled",
        "cancellation_revoked",
        "cancelled",
        "payment_succeeded",
        "payment_failed",
        "refund_created",
        "refund_succeeded",
        "refund_failed"
      ],
      "membership_type": [
        "created",
        "updated",
        "archived",
        "deleted"
      ],
      "event": [
        "created",
        "updated",
        "published",
        "unpublished",
        "visibility_changed",
        "cancelled",
        "deleted"
      ],
      "event_registration": [
        "created",
        "confirmed",
        "updated",
        "cancelled",
        "checked_in"
      ],
      "event_order": [
        "created",
        "confirmed",
        "cancelled",
        "payment_succeeded",
        "payment_failed",
        "refund_created",
        "refund_succeeded",
        "refund_failed"
      ],
      "donation": [
        "created",
        "payment_succeeded",
        "payment_failed",
        "refund_created",
        "refund_succeeded",
        "refund_failed",
        "dispute_opened",
        "dispute_closed"
      ],
      "donation_subscription": [
        "created",
        "activated",
        "updated",
        "past_due",
        "cancellation_scheduled",
        "cancellation_revoked",
        "cancelled"
      ],
      "donation_campaign": [
        "created",
        "updated",
        "published",
        "unpublished",
        "deleted"
      ]
    },
    "events": [
      {
        "event": "scan.created",
        "sample": {
          "scan": {
            "id": "507f1f77bcf86cd799439011",
            "company": "507f1f77bcf86cd799439010",
            "source": "web",
            "member": {
              "id": "507f1f77bcf86cd799439011",
              "name": "Example Member",
              "email": "member@example.com",
              "memberId": "MEM001"
            },
            "input": "EXAMPLE",
            "result": "success",
            "timestamp": "2030-05-01T18:00:00.000Z"
          }
        }
      },
      {
        "event": "member.created",
        "sample": {
          "member": {
            "id": "507f1f77bcf86cd799439011",
            "company": "507f1f77bcf86cd799439010",
            "memberId": "MEM001",
            "name": "Example Member",
            "email": "member@example.com",
            "status": "active"
          }
        }
      }
    ]
  }
}

Response Fields

Field	Type	Description	Attributes
success	boolean
message	string
data	object		Show child attributes groups: object — Resource names mapped to supported action names events: array of object Show child attributes event: scan.created, member.created, member.updated, member.status_changed, member.deleted, membership.created, membership.updated, membership.activated, membership.renewed, membership.expiring, membership.expired, membership.cancellation_scheduled, membership.cancellation_revoked, membership.cancelled, membership.payment_succeeded, membership.payment_failed, membership.refund_created, membership.refund_succeeded, membership.refund_failed, membership_type.created, membership_type.updated, membership_type.archived, membership_type.deleted, event.created, event.updated, event.published, event.unpublished, event.visibility_changed, event.cancelled, event.deleted, event_registration.created, event_registration.confirmed, event_registration.updated, event_registration.cancelled, event_registration.checked_in, event_order.created, event_order.confirmed, event_order.cancelled, event_order.payment_succeeded, event_order.payment_failed, event_order.refund_created, event_order.refund_succeeded, event_order.refund_failed, donation.created, donation.payment_succeeded, donation.payment_failed, donation.refund_created, donation.refund_succeeded, donation.refund_failed, donation.dispute_opened, donation.dispute_closed, donation_subscription.created, donation_subscription.activated, donation_subscription.updated, donation_subscription.past_due, donation_subscription.cancellation_scheduled, donation_subscription.cancellation_revoked, donation_subscription.cancelled, donation_campaign.created, donation_campaign.updated, donation_campaign.published, donation_campaign.unpublished, donation_campaign.deleted sample: object