Skip to main content

​
Set up API access, webhooks, and Slack

​
What does this do for me?

The Integrations page (Advanced) lets the Shopify store owner create a bearer token for the developer API, connect an outbound HTTPS webhook for campaign lifecycle events, and connect a Slack incoming webhook for notifications. Only the Shopify store owner can change API tokens or connected integrations. If the operator has not configured the integration encryption key, secret-backed integrations (webhooks and Slack) are unavailable, but API-token rotation still works because tokens are stored as one-way hashes.

​
Create an API token

  1. Open Integrations in the app. The page shows Advanced enabled on Advanced.
  2. Under Developer API, select Create API token (or Rotate API token if one already exists).
  3. Copy the new token immediately — it is shown once and stored only as a one-way hash. Rotating invalidates the previous token.
  4. Use the token as a bearer token with GET or POST /api/v1/campaigns. See the developer API overview for the details.
To remove access, select Revoke token and confirm.

​
Connect an outbound webhook

  1. Under Outbound webhooks, enter an HTTPS endpoint (a public HTTPS URL on port 443).
  2. Select the campaign lifecycle events you want to receive.
  3. Select Connect webhook, then copy the Signing secret immediately. It is shown once.
  4. Verify the x-campaign-conductor-signature HMAC over the exact request body at your endpoint.
The recent-deliveries table shows the status and HTTP response of each delivered event. To stop delivery, select Disconnect and confirm.

​
Connect Slack

  1. Under Slack notifications, enter a Slack incoming-webhook URL and an optional Channel label.
  2. Select Connect Slack.
Campaign lifecycle notifications are sent to Slack. The recent-deliveries table shows the delivery status. To stop, select Disconnect Slack and confirm.