Subscribe to Webhook Topic

Request

Creates a subscription to a specific webhook topic for an existing webhook configuration. The webhook will receive notifications for events matching the specified topic.

Security

ApiKey

Path

subscriber_idstring, (uuid)required

The unique identifier of the webhook configuration in Parallax.

Body

topicstringrequired

The event topic for this subscription (e.g., 'project.created', 'project.updated').

curl -i -X POST \
  'https://developer.getparallax.com/_mock/api-documentation/swagger/v1/webhook-subscribers/{subscriber_id}/subscriptions' \
  -H 'Content-Type: application/json-patch+json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "topic": "string"
  }'

Responses

Created

Bodyapplication/json

idstring, (uuid)

The unique identifier of the webhook subscription.

webhook_subscriber_idstring, (uuid)

The unique identifier of the parent webhook subscriber configuration.

topicstring

The event topic for this subscription (e.g., 'project.created', 'project.updated').

created_datestring, (date-time)

The date and time when the subscription was created.

modified_datestring, (date-time)

The date and time when the subscription was last modified.

Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "webhook_subscriber_id": "7d10da51-9c35-4cfd-9790-3a8386e2bc97",
  "topic": "string",
  "created_date": "2019-08-24T14:15:22Z",
  "modified_date": "2019-08-24T14:15:22Z"
}