Individual Webhooks | Constant Contact Developer

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

Description TOP

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

Description TOP

Privileges required : campaign:read

Retrieves the email campaign message specified by the campaignId path parameter. The tracking_summary data is current as of the last scheduled update, unless you set updateSummary =true to return updated data.

NOTE: Details of a deleted campaign cannot be retrieved. If a call is made to GET a deleted campaign by its ID, the call will fail and return a 404 Not Found response. You can login to the account to restore the campaign and then retrieve its details.

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

Privileges required : contacts:lists:read

GET a specific contact list (specified using the listId path parameter).

Description TOP

Privileges required : mylibrary:folder:read

Retrieve a specific MyLibrary folder using the folderId path parameter.

Description TOP

Privileges required : mylibrary:file:read

Retrieve a MyLibrary file using the fileId path parameter.

Description TOP

Privileges required : campaign:read

Retrieve an event item by using the eventId and itemId path parameters to specify the event and item.

Description TOP

Privileges required : campaign:read

Get a specific event object (specified by the event_id path parameter). Properties with a null value are not returned in the JSON response.

Description TOP

Privileges required : campaign:read

Retrieve detailed information about a specific registrant (specified by registrantId ) for an event (specified by eventId ).

Description TOP

Privileges required : campaign:read

Retrieve a specific promotional code for an event; use the promocodeId and eventId path parameters to specify the code and the event it belongs to.

name	type	default	description
GET: https://api.constantcontact.com/v2/webhooks/partner/topics/{topicId}
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 Codes TOP

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

Structure TOP

property	type (max length)	description

Response Structure TOP

property	type (max length)	description

Example Response TOP

{
    "id":"2",
    "name":"Billing Tier Downgrade",
    "description":"Executes when an account's billing tier is downgraded",
    "is_subscribed":false
}