Technology Partners Webhooks

POST Test Send Webhook Notification

Changed on

Use this POST method to validate a webhook subscription by triggering a test notification for your chosen webhook topic_id. Possible topic_id values include:

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

After you successfully send this request, Constant Contact will automatically send a POST notification to your chosen topic's callback URI with example data.

post/partner/webhooks/subscriptions/{topic_id}/tests

Request

  • Base URL
    https://api.cc.email/v3
  • URL
    https://api.cc.email/v3/partner/webhooks/subscriptions/{topic_id}/tests
  • 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.

Response

Test notification successfully sent to your callback URI.

topic_idinteger

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

hook_uristring

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

topic_namestring

The name of the topic.

topic_descriptionstring

A description of what the topic is and when Constant Contact notifies you concerning it. When you use the test send API method, Constant Contact will immediately send a test event to you.

Example response

{
  "topic_id": 2,
  "hook_uri": "https://www.examplename.com/webhooks/billingTier",
  "topic_name": "Billing Tier Downgrade",
  "topic_description": "Executes when an account's billing tier is downgraded."
}

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