Inbox

Webhooks

To send content to your inbox, first set up an inbox in Folo and obtain the inbox handle and secret.

Request Parameters

URL: https://api.follow.is/inboxes/webhook

Method: POST

Header:

Content-Type: application/json
X-Follow-Secret: {your inbox secret}
X-Follow-Handle: {your inbox handle}

Body:

type WebhookPayload = {
  guid: string;
  publishedAt: string;
  url?: string | null;
  description?: string | null;
  title?: string | null;
  content?: string | null;
  language?: string | null;
  author?: string | null;
  media?: {
    url: string;
    type: "photo" | "video";
    width?: number;
    height?: number;
    preview_image_url?: string;
    blurhash?: string;
  }[] | null;
  categories?: string[] | null;
  attachments?: {
    url: string;
    duration_in_seconds?: number | string;
    mime_type?: string;
    size_in_bytes?: number;
    title?: string;
  }[] | null;
  extra: {
    links?: {
      url: string;
      type: string;
      content_html?: string;
    }[] | null;
  } | null;
  authorUrl?: string | null;
  authorAvatar?: string | null;
}