Endpoints

Estimated reading: 2 minutes

When CampaignSuite is activated, a number of new endpoints will be added within WordPress. These endpoints can be accessed by third party software. These endpoints are explained below with the associated parameters.

gp_webhook_path

This endpoint can be accessed by Findock and handles all webhook calls related to changes to a payment (or in the case of Findock 2 changes in the PaymentIntent). CampaignSuite automatically determines whether it is for Findock v1 or v2 based on the content of the call. With every API call to Findock, CampaignSuite automatically adds this URL as WebhookURL. Example

				
					{root_url}/wp-json/campaignsuite/v1/gp_webhook_path

update_mautic_integration

This endpoint can be used to remove a Mautic Lead Integration. This endpoint can only be accessed with a POST request with the following parameters:

Parameter	Description
email	The email address of a Mautic lead
entityId	The Mautic entity to delete
entityId	The Salesforce entity ID (eg, Campaign ID)

Example

				
					{root_url}wp-json/campaignsuite/v1/update_mautic_integration

update_lead_field

This endpoint can be used to remove a Mautic Lead Integration. This endpoint can only be accessed with a POST request with the following parameters:

Parameter	Description
email	The email address of a Mautic lead
field	The Mautic field alias to update
value	The new value to save
action	Choose from 'add' or 'remove' here

Example

				
					{root_url}wp-json/campaignsuite/v1/update_lead_field