Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.portal.io/llms.txt

Use this file to discover all available pages before exploring further.

Returns all webhook subscriptions registered for your dealer account. Use this endpoint to audit your current subscriptions, retrieve subscription IDs for update or delete operations, or verify which event types are configured for each endpoint.

​
Request

GET /public/webhook/subscriptions

​
Headers

​
Accept
string
required
Must be application/json.
​
X-MSS-API-APPID
string
required
Your API Application Key.
​
X-MSS-API-USERKEY
string
required
Your User API Key.
​
X-MSS-CUSTOM-DATE
string
required
Current UTC timestamp in RFC 7231 format (e.g. Mon, 06 Apr 2026 00:22:19 GMT).
​
X-MSS-SIGNATURE
string
required
HMAC-SHA256 signature of the canonical request, Base64-encoded.

​
Response

​
200 Success

Returns an array of subscription objects. An empty array is returned when no subscriptions exist.
​
subscriptionId
integer
required
Unique numeric identifier of the subscription.
​
url
string
required
The HTTPS callback URL registered for this subscription.
​
description
string
Optional human-readable label for this subscription.
​
enabled
boolean
required
Whether the subscription is currently active. Disabled subscriptions will not receive event deliveries.
​
events
array
required
Array of event type strings this subscription is registered for.

​
Error Codes

CodeMeaning
401HMAC signature validation failed or credentials are invalid.
402An active Portal.io subscription is required to use this endpoint.
403Your user account does not have permission for this action.

​
Example

curl -i -X GET \
  'https://api.portal.io/public/webhook/subscriptions' \
  -H 'Accept: application/json' \
  -H 'X-MSS-API-APPID: YOUR_APP_ID' \
  -H 'X-MSS-API-USERKEY: YOUR_USER_KEY' \
  -H 'X-MSS-CUSTOM-DATE: Mon, 06 Apr 2026 00:22:19 GMT' \
  -H 'X-MSS-SIGNATURE: BASE64_SIGNATURE'

[
  {
    "subscriptionId": 42,
    "url": "https://app.example.com/webhooks/portal",
    "description": "Production webhook",
    "enabled": true,
    "events": [
      "proposal.status_changed",
      "proposal.build.status_update"
    ]
  },
  {
    "subscriptionId": 43,
    "url": "https://staging.example.com/webhooks/portal",
    "description": "Staging webhook",
    "enabled": false,
    "events": [
      "proposal.outline.status_update"
    ]
  }
]