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

DescriptionTOP

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

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 CodesTOP

code

description

200

Request was successful

401

Authentication failure

406

Unsupported Accept Header value, must be application/json

500

Internal server error occurred

StructureTOP

property

type(max length)

description

callback_uri

string (512)

The URI of the server configured to receive the Constant Contact webhook notification POST. Must begin with https://

description

string

Brief description of the partner webhook topic

id

string

Unique ID of the partner webhook topic

is_subscribed

boolean

Identifies if you are subscribed (TRUE) to the topic or not (FALSE)

name

string (40)

Name of the partner webhook topic

Example ResponseTOP

[
  {
    "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"
  }
]