subscriptions

Get subscription

Retrieves detailed information about a specific subscription.

This endpoint returns comprehensive details about the requested subscription:

Creation and last modification dates
Consumer URL where webhook events are sent
Technical contact information
Current status (enabled/disabled)
List of topics this subscription is listening for
Integration type of the current subscription

Use this endpoint when you need to check the configuration of a specific subscription.

get/subscriptions/{subscriptionId}

Request

Base URL
https://api.acculynx.com/webhooks/v2
URL
https://api.acculynx.com/webhooks/v2/subscriptions/{subscriptionId}
Auth
HTTP bearer

Path parameters

subscriptionIdstring uuid required

The unique identifier (UUID) of the subscription you want to interact with. This ID is returned when you create a subscription and can be retrieved from the GET /subscriptions endpoint.

Response

The given subscription

_linkstring uri

The full URI that can be used to access this subscription. This is a convenience to avoid having to construct the URL yourself.

idstring uuid

The unique identifier of the subscription. Use this ID in path parameters when working with specific subscriptions.

consumerUrlstring

The URL where webhook events are sent for this subscription. All webhook events will be sent as POST requests to this URL.

createdDatestring date-time

The date and time when this subscription was created. Always provided in UTC format.

modifiedDatestring date-time

The date and time when this subscription was last modified. Always provided in UTC format. Updates when any subscription property changes.

status'enabled' | 'disabled'

The current status of the subscription. - enabled: The subscription is active and will receive webhook events - disabled: The subscription is inactive and will not receive webhook events

tech_contactstring email

The technical contact email address for this subscription. AccuLynx will use this email to communicate important information about the subscription.

topicNamesstring[]

List of event topics this subscription is listening for. Only events matching these topic names will be sent to the consumer URL.

integrationType'Api' | 'Zapier'

The current integration type of the subscription.

Example response

{
  "_link": "https://api.acculynx.com/webhooks/v2/subscriptions/b8270e49-f71d-4b49-aa0a-68bc75090ab5",
  "id": "01a7cfc1-2231-4589-9657-7f3004c06bd3",
  "consumerUrl": "https://www.your-domain.com/webhooks",
  "tech_contact": "support@your-company.com",
  "topicNames": [
    "milestone-changed"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.