Ayrshare

App · 20 actions

Publish across linked social accounts, track posts and short links, and monitor webhook events.

Actions

ActionWhat it does
Add commentPost a comment on selected social networks for an Ayrshare post.
Check media URLCheck whether Ayrshare can reach a public media URL.
Create short linkCreate a tracked short link to an HTTPS URL.
Delete postCancel a scheduled post or remove a published post from its networks.
Get account analyticsRead account metrics for selected linked social networks.
Get media metadataRead dimensions, encoding, and duration for a public media URL.
Get postRead a post and its current publishing status.
Get post analyticsRead engagement and performance metrics for an Ayrshare post.
Get post historyRead the publishing history of one Ayrshare post.
Get profile and connected accountsRead linked social accounts and usage for the connected Ayrshare profile.
Get short link analyticsRead tracking metrics for a short link.
List media galleryList images and videos uploaded to the media gallery.
List post commentsGet comments for an Ayrshare post.
List post historyRead posts sent or scheduled through Ayrshare, newest first.
List registered webhooksList webhook destinations for the connected profile.
List webhook deliveriesRead recent webhook events, grouped by event type.
Publish or schedule postSend a post to selected linked networks now or at a future time.
Register webhook destinationSend one type of Ayrshare event to an existing public HTTPS receiver.
Unregister webhook destinationStop webhook deliveries for one event type on this profile.
Update post settingsUpdate notes or reschedule a pending post.

Add comment

Post a comment on selected social networks for an Ayrshare post.

Inputs

Post IDpost_idtextRequired
Enter the Ayrshare post ID.
CommentcommenttextRequired
Enter the comment text.
PlatformsplatformslistRequired
Choose the linked accounts to comment on.One or more of: bluesky, facebook, instagram, linkedin, reddit, tiktok, twitter, youtube.

Outputs

dataobject
The response from Ayrshare.
Example output
{
  "data": {}
}

Check media URL

Check whether Ayrshare can reach a public media URL.

Inputs

Media URLmedia_urltextRequired
Enter the public media URL.

Outputs

dataobject
The response from Ayrshare.
Example output
{
  "data": {
    "contentType": "example",
    "status": "example",
    "statusCode": 1
  }
}

Create a tracked short link to an HTTPS URL.

Inputs

URLurltextRequired
Enter the HTTPS destination URL.
UTM sourceutm_sourcetext
Enter the campaign's traffic source.
UTM campaignutm_campaigntext
Enter the campaign name.

Outputs

dataobject
The response from Ayrshare.
Example output
{
  "data": {
    "id": "example",
    "originalUrl": "example",
    "shortUrl": "example"
  }
}

Delete post

Cancel a scheduled post or remove a published post from its networks.

Inputs

Post IDpost_idtextRequired
Enter the Ayrshare post ID.

Outputs

dataobject
The response from Ayrshare.
Example output
{
  "data": {
    "id": "example",
    "status": "example"
  }
}

Get account analytics

Read account metrics for selected linked social networks.

Inputs

PlatformsplatformslistRequired
Choose which social networks to include.One or more of: bluesky, facebook, gmb, instagram, linkedin, pinterest, reddit, snapchat, telegram, threads, and 3 more.

Outputs

dataobject
The response from Ayrshare.
Example output
{
  "data": {}
}

Get media metadata

Read dimensions, encoding, and duration for a public media URL.

Inputs

URLurltextRequired
Enter the public media URL.

Outputs

dataobject
The response from Ayrshare.
Example output
{
  "data": {}
}

Get post

Read a post and its current publishing status.

Inputs

Post IDpost_idtextRequired
Enter the Ayrshare post ID.

Outputs

dataobject
The response from Ayrshare.
Example output
{
  "data": {
    "id": "example",
    "platforms": [
      "example"
    ],
    "post": "example",
    "postIds": [
      {}
    ],
    "status": "example"
  }
}

Get post analytics

Read engagement and performance metrics for an Ayrshare post.

Inputs

Post IDpost_idtextRequired
Enter the Ayrshare post ID.
Platformsplatformslist
Choose which social networks to include.One or more of: bluesky, facebook, gmb, instagram, linkedin, pinterest, reddit, snapchat, telegram, threads, and 3 more.
Dailydailytrue/false
Include a daily breakdown when available.

Outputs

dataobject
The response from Ayrshare.
Example output
{
  "data": {}
}

Get post history

Read the publishing history of one Ayrshare post.

Inputs

Post IDpost_idtextRequired
Enter the Ayrshare post ID.

Outputs

dataobject
The response from Ayrshare.
Example output
{
  "data": {
    "id": "example",
    "platforms": [
      "example"
    ],
    "post": "example",
    "postIds": [
      {}
    ],
    "status": "example"
  }
}

Get profile and connected accounts

Read linked social accounts and usage for the connected Ayrshare profile.

Inputs

Instagram detailsinstagram_detailstrue/false
Include additional Instagram account details.

Outputs

dataobject
The response from Ayrshare.
Example output
{
  "data": {
    "activeSocialAccounts": [
      "example"
    ],
    "displayNames": [
      {}
    ]
  }
}

Read tracking metrics for a short link.

Inputs

Link IDlink_idtextRequired
Enter the ID from Create short link.

Outputs

dataobject
The response from Ayrshare.
Example output
{
  "data": {}
}

List images and videos uploaded to the media gallery.

Inputs

None.

Outputs

dataobject
The response from Ayrshare.
Example output
{
  "data": {}
}

List post comments

Get comments for an Ayrshare post.

Inputs

Post IDpost_idtextRequired
Enter the Ayrshare post ID.
Platformplatformtext
Only get comments from this social network.One of: bluesky, facebook, gmb, instagram, linkedin, pinterest, reddit, snapchat, telegram, threads, and 3 more.

Outputs

dataobject
The response from Ayrshare.
Example output
{
  "data": {}
}

List post history

Read posts sent or scheduled through Ayrshare, newest first.

Inputs

Limitlimitnumber
Maximum number of posts to return.From 1 to 1000.
Statusstatustext
Choose which post status to list.One of: success, error, processing, pending, paused, deleted, awaiting approval.
Start timestart_timedate and time
Include posts from this date and time.
End timeend_timedate and time
Include posts through this date and time.
Last dayslast_daysnumber
Limit to this many days. Use zero for the full history.At least 0.

Outputs

dataobject
The response from Ayrshare.
Example output
{
  "data": {
    "history": [
      {
        "id": "example",
        "platforms": [
          "example"
        ],
        "post": "example",
        "postIds": [
          {}
        ],
        "status": "example"
      }
    ],
    "lastUpdated": "example"
  }
}

List registered webhooks

List webhook destinations for the connected profile.

Inputs

None.

Outputs

dataobject
The response from Ayrshare.
Example output
{
  "data": {}
}

List webhook deliveries

Read recent webhook events, grouped by event type.

Inputs

Action typeaction_typetext
Choose one event type, or leave empty for all types.One of: social, scheduled, messages, feed, batch, mentions, comments, automations, demo, suspended, ads.

Outputs

dataobject
The response from Ayrshare.
Example output
{
  "data": {
    "ads": [
      {
        "action": "example",
        "created": "example",
        "hookId": "example"
      }
    ],
    "automations": [
      {
        "action": "example",
        "created": "example",
        "hookId": "example"
      }
    ],
    "batch": [
      {
        "action": "example",
        "created": "example",
        "hookId": "example"
      }
    ],
    "comments": [
      {
        "action": "example",
        "created": "example",
        "hookId": "example"
      }
    ],
    "demo": [
      {
        "action": "example",
        "created": "example",
        "hookId": "example"
      }
    ],
    "feed": [
      {
        "action": "example",
        "created": "example",
        "hookId": "example"
      }
    ],
    "mentions": [
      {
        "action": "example",
        "created": "example",
        "hookId": "example"
      }
    ],
    "messages": [
      {
        "action": "example",
        "created": "example",
        "hookId": "example"
      }
    ],
    "scheduled": [
      {
        "action": "example",
        "created": "example",
        "hookId": "example"
      }
    ],
    "social": [
      {
        "action": "example",
        "created": "example",
        "hookId": "example"
      }
    ],
    "suspended": [
      {
        "action": "example",
        "created": "example",
        "hookId": "example"
      }
    ]
  }
}

Publish or schedule post

Send a post to selected linked networks now or at a future time.

Inputs

Postposttext
Enter the post text.
PlatformsplatformslistRequired
Choose the linked accounts to publish to.One or more of: bluesky, facebook, gmb, instagram, linkedin, pinterest, reddit, snapchat, telegram, threads, and 3 more.
Media URLSmedia_urlslist
Enter the public image or video URLs.
Schedule dateschedule_datedate and time
Choose a future date and time, or leave empty to publish now.
Youtube titleyoutube_titletext
Enter the video title when publishing to YouTube.
Pinterest board IDpinterest_board_idtext
Enter the board ID when publishing to Pinterest.
Is videois_videotrue/false
Treat the supplied media as video.
Shorten linksshorten_linkstrue/false
Shorten the links in the post.
Requires approvalrequires_approvaltrue/false
Hold the post for approval.
Idempotency keyidempotency_keytext
Set a distinct key per post to prevent duplicates on repeat calls.

Outputs

dataobject
The response from Ayrshare.
Example output
{
  "data": {
    "id": "example",
    "postIds": [
      {}
    ],
    "status": "example"
  }
}

Register webhook destination

Send one type of Ayrshare event to an existing public HTTPS receiver.

Inputs

Action typeaction_typetextRequired
Choose the event type to send.One of: social, scheduled, messages, feed, batch, mentions, comments, automations, demo, suspended, ads.
URLurltextRequired
Enter the HTTPS URL that receives the events.

Outputs

dataobject
The response from Ayrshare.
Example output
{
  "data": {
    "action": "example",
    "refId": "example",
    "status": "example"
  }
}

Unregister webhook destination

Stop webhook deliveries for one event type on this profile.

Inputs

Action typeaction_typetextRequired
Choose the event type to remove.One of: social, scheduled, messages, feed, batch, mentions, comments, automations, demo, suspended, ads.

Outputs

dataobject
The response from Ayrshare.
Example output
{
  "data": {
    "action": "example",
    "refId": "example",
    "status": "example"
  }
}

Update post settings

Update notes or reschedule a pending post.

Inputs

Post IDpost_idtextRequired
Enter the Ayrshare post ID.
Notesnotestext
Enter internal notes for the post.
Schedule dateschedule_datedate and time
Choose a new future publication time.

Outputs

dataobject
The response from Ayrshare.
Example output
{
  "data": {
    "id": "example",
    "postIds": [
      {}
    ],
    "status": "example"
  }
}

On this page