Available on Premium, Business, Enterprise plans.
What is a Webhook?
A Webhook allows you to be notified when certain system actions occur via a call to a URL you provide. Webhooks are also known as “URL Callbacks” or “HTTP push calls”. Your URL must use SSL and begin with HTTPS.Webhook Actions
See the available actions for webhooks.
Understanding Ayrshare Webhooks
Webhooks are categorized by the specific action and are registered at the Primary Profile or User Profile level. Any updates for the Primary or User Profiles are sent first to the registered Webhook for the User Profile. If User Profile does not have a registered Webhook, the update will be sent to the Primary Profile registered Webhook. For example:- If a User Profile has a registered Social Action Webhook and unlinks TikTok, the registered Social Action Webhook URL for the User Profile will be called. The Primary Profile webhook will not be called.
- If a User Profile unlinks TikTok and does not have a registered Social Action Webhook, but the Primary Profile does have a registered Webhook, the registered Social Action Webhook URL for the Primary Profile will be called.
Register a Webhook
Register a Webhook by providing an endpoint URL and the type of action type to the POST/hook/webhook
endpoint. When the action occurs an HTTP POST
message will be sent to the provided URL.
E.g. register a URL to get notified of the status of scheduled post.
The Webhook endpoint URL should not use redirects and must be the final destination URL.
If you only register the Primary Profile webhook, the User Profiles will automatically inherit the Primary Profile webhook.
To have a unique webhook for each User Profile, you must register a webhook for each User Profile.
After your Webhook receives the
HTTP POST
, your server must respond with
an HTTP status of 200
to mark the call as successful. If your server does
not respond within 10 seconds, a 503
response will be recorded.Webhook Retries
If the HTTP response from your server is not in the200-299
success range, the system will automatically retry the Webhook call two more times. The first retry will occur after 5 seconds and the second retry will occur 30 seconds later. The retries will have the same hookId
and be marked as attempted retries.