ACacculynx
subscriptions

Create Subscription

Creates a new webhook subscription for your company.

You must provide:

  • A valid consumer URL where webhook events will be sent
  • A technical contact email for notifications about the subscription
  • At least one topic name to subscribe to
  • An integration type that indicates the purpose of the subscription Upon successful creation, you'll receive a subscription ID that you can use to manage this subscription.
post/subscriptions

Request

  • Base URL
    https://api.acculynx.com/webhooks/v2
  • URL
    https://api.acculynx.com/webhooks/v2/subscriptions
  • Auth
    HTTP bearer

Request body

consumerUrlstring uri required

The URL where webhook events will be sent.

  • Must be a valid, publicly accessible HTTPS URL
  • Must respond to POST requests
  • Cannot be changed after subscription creation
techContactstring email required

Email address for technical contact.

  • Used for notifications about subscription status changes
  • Used for troubleshooting communication
  • Should be monitored regularly
topicNamesstring[] required

A collection of topic names to subscribe to.

  • Must contain at least one valid topic name
  • Each topic name must be a string matching an available topic
  • Use GET /topics to retrieve the list of available topics
integrationType'Api'

Type that indicates the purpose of the subscription. If nothing is specified, integration type will be Api by default.

Example request

{
  "consumerUrl": "https://www.your-domain.com/webhooks",
  "techContact": "some-name@some-domain.com",
  "topicNames": [
    "milestone-change"
  ],
  "integrationType": "Api"
}

Response

Ok

subscriptionIdstring uuid

The unique identifier for the newly created subscription. Use this ID for all future operations on this subscription.

Example response

{
  "subscriptionId": "1b9b1f4e-30e1-4918-99c2-aecd236ccd94"
}

Changes

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