OrbitwriteDocs

API reference

Triggers

1 endpoint, served at https://orbitwrite.com/api/v1. Each one lists the credentials it accepts, its parameters and every response it can give.

Endpoints
POST/api/v1/triggers/discover

Discover the merge tokens a trigger source exposes#

POST/api/v1/triggers/discover

Fetches an RSS/Atom feed, Ghost blog or WordPress site, samples its most recent item, and returns the merge tokens available to a post template built from it.

Authentication

An API key or OAuth access token as a bearer token, or a signed-in session.

Body application/json

sourcestringRequired
  • "rss"
  • "ghost"
  • "wordpress"
urlstringRequired

Format uri.

Responses

200TriggerDiscovery

Tokens discovered on the source

Response attributes
tokensDiscoveredToken[]Required
Child attributes
tokenstringRequired

Merge token as it appears in a template, e.g. {{title}}.

previewValuestringRequired

The value this token resolved to on the sampled item, truncated for display.

kindstringRequired
  • "text"
  • "url"
  • "image"
  • "date"
  • "list"
sampleSourcestringRequired

Human-readable label for the item the tokens were sampled from, e.g. First feed item · How I built X.

400Error

Invalid request

Response attributes
errorstringRequired
issuesany[]
401Error

Not signed in

Response attributes
errorstringRequired
issuesany[]
429Error

Rate limit exceeded

Response attributes
errorstringRequired
issuesany[]
POST /api/v1/triggers/discover
curl -X POST "https://orbitwrite.com/api/v1/triggers/discover" \
  -H "Authorization: Bearer $ORBITWRITE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "source": "rss",
  "url": "https://example.com"
}'
Response
{
  "tokens": [
    {
      "token": "string",
      "previewValue": "string",
      "kind": "text"
    }
  ],
  "sampleSource": "string"
}