Get webhook subscription

GET /webhook-subscriptions/{id}

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

Authorization

X-API-Key required

Parameters

Name	Location	Type	Required	Description
id	path	string	Yes	RemyPass resource _id

Request Examples

curl -X GET "https://api.remypass.com/api/v1/public/webhook-subscriptions/507f1f77bcf86cd799439011" \
  -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.
404	Resource not found.
429	Rate limit exceeded.
500	Server error.

200 Response Example

{
  "success": true,
  "message": "Success",
  "data": {
    "_id": "507f1f77bcf86cd799439011",
    "name": "Example",
    "description": "example",
    "url": "https://example.com/webhook",
    "events": [
      "scan.created"
    ],
    "active": true,
    "lastDeliveryAt": "2026-10-06T12:00:00.000Z",
    "lastSuccessfulDeliveryAt": "2026-10-06T12:00:00.000Z",
    "failureCount": 0,
    "maxRetries": 3,
    "retryDelaySeconds": 60,
    "timeoutSeconds": 30,
    "createdAt": "2026-10-06T12:00:00.000Z",
    "updatedAt": "2026-10-06T12:00:00.000Z"
  }
}

Response Fields

Field	Type	Description	Attributes
success	boolean
message	string
data	object		Show child attributes _id: string — RemyPass record _id name: string — name description: string — description url: string — url events: array of 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 — events active: boolean — active lastDeliveryAt: string (date-time) — last Delivery At lastSuccessfulDeliveryAt: string (date-time) — last Successful Delivery At failureCount: number — failure Count maxRetries: number — max Retries retryDelaySeconds: number — retry Delay Seconds timeoutSeconds: number — timeout Seconds createdAt: string (date-time) — created At updatedAt: string (date-time) — updated At