Technology Partners Webhooks

PUT Webhook Topic Subscription

Changed on

Use this PUT method to subscribe your application to a topic_id or to update the callback URI for an existing subscription. Possible topic_id values include:

  • 1 - Billing tier upgrade.
  • 2 - Billing tier downgrade.
  • 3 - Account cancelled.
  • 4 - Account disabled.

After you subscribe your application, Constant Contact will automatically start sending POST notifications for your chosen topic to your application's callback URI. This is an example of the POST notification request body:

{"url":"https://api.cc.email/v3/partner/accounts/a07e1my9tbw0/plan",
"api_key":"90ed8738-5190-44a3-bc12-c172930db12c",
"event_type":"tier.increase"}
</br> If your application does not return a success response after receiving a notification, Constant Contact will retry sending the POST notification at 1 minute intervals for up to an hour.
put/partner/webhooks/subscriptions/{topic_id}

Request

  • Base URL
    https://api.cc.email/v3
  • URL
    https://api.cc.email/v3/partner/webhooks/subscriptions/{topic_id}
  • Auth
    OAuth 2 and API key in header x-api-key
    Implicit: https://v3api-partner.auth.us-east-1.amazoncognito.com/oauth2/token

Path parameters

topic_idstring required

Identifies a webhook topic.

Request body

hook_uristring

The callback URI you would like to use to receive webhook notifications. Constant Contact will automatically send POST notifications about your chosen topic to this URI.

Example request

{
  "hook_uri": "https://www.examplename.com/webhooks/billingTier"
}

Response

Request successful.

topic_idinteger

Identifies the topic using an integer to indicate the type of topic.

hook_uristring

Your webhook callback URI. Constant Contact automatically sends POST requests to this URI to notify you about the topic.

Example response

{
  "topic_id": 1,
  "hook_uri": "https://www.examplename.com/webhooks/billingTier"
}

Changes

  • 2483585c5d89Revision changes
    • info

      the endpoint scheme security ctctPartnerAuthorizer AND api_key was added to the API

    • info

      the endpoint scheme security api_key was removed from the API

    • info

      the endpoint scheme security ctctPartnerAuthorizer was removed from the API

  • 61b076c96be7Revision changes
    • info

      api tag Technology Partners Webhooks added

    • info

      api tag Technology Partners removed