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

Individual Partner Webhooks - View, Subscribe, Unsubscribe

Use this endpoint to view (GET), subscribe to (PUT) or unsubscribe from (DELETE or PUT) a Partner Webhook topic.

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

Methods:

Click a method to view its documentation

GET PUT DELETE

DescriptionTOP

Subscribe to or unsubscribe from a partner webhook topic by making a PUT call to this endpoint with a properly constructed request payload, as shown here. Specify the topic using the topicId path parameter.

PUT: https://api.constantcontact.com/v2/webhooks/partner/topics/{topicId}

name

type

default

description

api_key

query

REQUIRED; The API key for the application; key must have Partner level API Access

topicId

path

Unique ID for the partner webhook topic

Example JSON Request BodyTOP

{
    "is_subscribed":true,
    "callback_uri":"https://wwww.example.com/webhook/billingTier"
}

Response CodesTOP

code

description

200

Successfully subscribed to the topic

400

Either JSON was malformed or there was a data validation error

401

Authentication failure

404

The specified topicId does not exist

406

Unsupported accept header value, must be application/json

415

Unsupported content-type in the header, must be application/json

500

Internal server error occurred

StructureTOP

property

type(max length)

description

callback_uri

string (512)

REQUIRED. only when subscribing to a topic; The URI of the server configured to receive the Constant Contact webhook notification POST. Must begin with https://

is_subscribed

boolean

REQUIRED. Use true to subscribe, false to unsubscribe from the topic

Example ResponseTOP

{
    "name" : "Billing Tier Change Upgrade",
    "description" : "Executes when an account's billing tier is increased",
    "is_subscribed" : true,
    "callback_uri" : "https://www.example.com/webhook/billingTier"
 }