ACME API Documentation logo

Register Webhook

Register a new Webhook

POSThttps://api.acme.com/api/hook/webhook
Available on Premium, Business, Enterprise plans.

Register Webhook

Register a new Webhook for one of the available actions. A Webhook may be registered with the Primary Profile or a User Profile.

You may also register a webhook in the ACME dashbboard on the Webhooks page.

Header Parameters

Authorizationstringrequired
API Key of the Primary Profile.

Format: Authorization: Bearer API_KEY
Profile-Keystring
Profile Key of a User Profile.

Format: Profile-Key: PROFILE_KEY

Body Parameters

actionstringrequired

Available actions: feed, social, scheduled, batch, messages, accountActivity

urlstringrequired

The URL to be called on action. URL must be in a valid format and begin with https://

secretstring

Secret text used for HMAC. Please see overview for more details.

{
  "status": "success",
  "action": "scheduled",
  "url": "https://mysite.com/hook",
  "refId": "3dc079614bdc3f281d9" // User Profile Ref Id
}