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

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

GET: 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

ALL

Specifies the partner webhook topic to retrieve

Response CodesTOP

code

description

200

Request was successful

401

Authentication failure

404

The specified topicId does not exist

406

Unsupported Accept Header value, must be application/json

500

Internal server error occurred

StructureTOP

property

type(max length)

description

callback_uri

string (512)

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

Use true to subscribe, false to unsubscribe from the topic

Response 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":"2",
    "name":"Billing Tier Downgrade",
    "description":"Executes when an account's billing tier is downgraded",
    "is_subscribed":false
}