Our v3 API is now available! Learn more by visiting the v3 developer portal . Creating new v2 API keys is no longer supported.

Partner Webhooks Collection

Use this endpoint to view (GET) a collection of webhook topics.

NOTE: This partner-only endpoint uses basic authentication as documented on this page .

Methods:

Click a method to view its documentation

GET

Description TOP

Retrieve a specific partner webhook topic by specifying the topicId path parameter. See the available topic ID's here .

Description TOP

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).

Description TOP

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:

  • SUBSCRIBED returns all topic to which you are subscribed
  • NOT_SUBSCRIBED returns all topics to which you are not subscribed
  • ALL (default) returns all topics

Response Codes TOP

code

description

200

Request was successful

401

Authentication failure

406

Unsupported Accept Header value, must be application/json

500

Internal server error occurred

Structure TOP

property

type (max length)

description

Example Response TOP

  1. [
  2. {
  3. "id":"1",
  4. "name":"Billing Tier Upgrade",
  5. "description":"Executes when an account's billing tier is upgraded",
  6. "is_subscribed":false
  7. },
  8. {
  9. "id":"2",
  10. "name":"Billing Tier Downgrade",
  11. "description":"Executes when an account's billing tier is downgraded",
  12. "is_subscribed":true,
  13. "callback_uri":"https://my.host.com/webhooks"
  14. }
  15. ]