webhooks

Ayrshare Home Login Business Plan Chat with Us

Search…

webhooks

Webhook API Endpoint: Register a webhook to receive asynchronous updates on events.

Webhooks API Endpoint
A webhook allows you to be notified when certain system actions occur via a call to a URL you provide. Register a webhook by providing your URL and the type of action you wish to be notified. When the action occurs a POST message will be sent to the provided URL.
Business Plan required.
Click the › in the endpoint to view details.
post
https://app.ayrshare.com/api
/hook/webhook
Register Webhook
​
delete
https://app.ayrshare.com/api
/hook/webhook
Unregister Webhook
​
get
https://app.ayrshare.com/api
/hook/webhook
List Registered Webhooks
Actions
Scheduled Action
Notification when a scheduled post has been processed. Only future scheduled posts receive a webhook notification. 
Business Plan required.
POST Action to Your URL
1
{
2
    "action": "scheduled",          // The action taken
3
    "refId": "140b8700bd6ade089b242d845e268fb886130c53", // User Reference ID
4
    "status": "success",            // success or error
5
    "id": "TBAAAqAMMpoweA9wKHUp",   // Ayrshare id of post
6
    "errors": [],                   // List of errors if any occurred
7
    "postIds": [                    // Individual successful posts status
8
        {
9
            "postUrl" :"https://www.facebook.com/102775127855689_361718068618052",
10
            "platform": "facebook",
11
            "status":"success",
12
            "id":"102775127855689_361718068618052"
13
        }
14
    ]
15
}
Copied!
Social Action
Notification when a user's profile links or unlinks a social network.
Business Plan required.
POST Action to Your URL
1
{
2
    "action": "social",       // The action taken
3
    "refId": "140b8700bd6ade089b242d845e268fb886130c53", // User Reference ID
4
    "type": "link",           // Type of action: link or unlink
5
    "platform": "instagram",   // The social platform the action occured
6
    "displayName": "Instagram Title" // optional: if a user account name is present at the social network
7
}
Copied!
​
Feed Action
Notification when a new RSS feed item is found for registered RSS feeds. Note: if the webhook is active, new RSS items will not be automatically posted to the social networks.
Business Plan required.
POST Action to Your URL
1
{
2
    "action": "feed",
3
    "refId": "140b8700bd6ade089b242d845e268fb886130c53", // User Reference ID
4
    "title": "Title of profile if available", // optional, only if available
5
    "data": { ... }
6
}
Copied!
​