Skip to main content
GET
/
public
/
webhook
/
subscriptions
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"
    ]
  }
]
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. 
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"
    ]
  }
]

Headers

​
Accept
enum<string>
required

Accept Header

Available options:
application/json
​
X-MSS-API-APPID
string
required

Application Id

​
X-MSS-CUSTOM-DATE
string
required

A date timestamp of the request

​
X-MSS-SIGNATURE
string
required

A signature for the request

​
X-MSS-API-USERKEY
string
required

User API Key

Response

Success

​
subscriptionId
integer<int64>
required

Unique numeric identifier of the webhook subscription

​
url
string
required

HTTPS URL that receives webhook POST deliveries

​
enabled
boolean
required

Whether the subscription is enabled

​
events
string[]
required

Event names that trigger this subscription

​
description
string

Optional human-readable label for the subscription

​
secretKey
string

Signing secret used to verify webhook deliveries. Only returned when a new secret is issued, such as during create or update operations