Use this endpoint to view (GET) a collection of webhook topics.
NOTE: This partner-only endpoint uses basic authentication as documented on this page .
Click a method to view its documentation
Retrieve a specific partner webhook topic by specifying the
topicId
path parameter. See the available topic ID's
here
.
Retrieves a list of partner webhook topics. Use the
subscription_status
query parameter to filter the list as follows:
subscription_status=ALL
returns all topics (ALL is the default value if query param not included)
subscription_status=SUBSCRIBED
returns only topics to which I am subscribed
subscription_status=NOT_SUBSCRIBED
returns only topics to which I am not subscribed
Currently, two webhook topics are available: billing tier upgrades (topic 1), and billing tier downgrades (topic 2).
Retrieve the current billing information for the account specified by the
accountId
path parameter.
NOTE : You must be set up for either single- or partner-billing in order to access and manage account billing plans.
GET: https://api.constantcontact.com/v2/webhooks/partner/topics |
|||
name |
type |
default |
description |
---|---|---|---|
api_key |
query |
|
REQUIRED; The API key for the application; key must have Partner level API Access |
subscription_status |
query |
ALL |
Filters the list of topics based on subscription, as follows:
|
code |
description |
---|---|
200 |
Request was successful |
401 |
Authentication failure |
406 |
Unsupported Accept Header value, must be application/json |
500 |
Internal server error occurred |
property |
type (max length) |
description |
---|
- [
- {
- "id":"1",
- "name":"Billing Tier Upgrade",
- "description":"Executes when an account's billing tier is upgraded",
- "is_subscribed":false
- },
- {
- "id":"2",
- "name":"Billing Tier Downgrade",
- "description":"Executes when an account's billing tier is downgraded",
- "is_subscribed":true,
- "callback_uri":"https://my.host.com/webhooks"
- }
- ]