PHPFUI/InstaDoc

Methods

public __construct(PHPFUI\ConstantContact\Client $client)

public delete(string $topic_id) : bool

DELETE Webhook Topic Subscriptions

Use this DELETE method to unsubscribe your application from notifications on a certain topic_id. Possible topic_id values include:

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

param string $topic_id Identifies a webhook topic.

public get(string $topic_id) : array

GET Webhook Topic Subscription

Use this GET method to return subscription information for a certain topic_id. Possible topic_id values include:

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

param string $topic_id Identifies a webhook topic.

public PHPFUI\ConstantContact\Base::getLastError() : string

public PHPFUI\ConstantContact\Base::getResponseText() : string

public PHPFUI\ConstantContact\Base::getStatusCode() : int

public PHPFUI\ConstantContact\Base::next() : array

If the endpoint is paginated, you can call next() to retrieve the next set of data. If no next is provided, an empty array is returned.

return array filled with next part of the response from the endpoint, or empty if no next.

public put(string $topic_id, PHPFUI\ConstantContact\Definition\WebhooksSubscriptionBody $body) : array

PUT Webhook Topic Subscription

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"}

param string $topic_id Identifies a webhook topic.
param \PHPFUI\ConstantContact\Definition\WebhooksSubscriptionBody $body A JSON payload containing a callback URI. Constant Contact uses this callback URI to notify you about your chosen topic.

public PHPFUI\ConstantContact\Base::success() : bool