API reference
6 endpoints, served at https://orbitwrite.com/api/v1. Each one lists the credentials it accepts, its parameters and every response it can give.
Returns the organization the API key is scoped to — or, for an OAuth access token (orbitwrite login), the workspace the person signed in to. Used by integrations (e.g. Zapier) to test the connection and label it.
An API key or OAuth access token as a bearer token.
200ApiIdentityThe key's organization
organizationobjectRequiredcurl -X GET "https://orbitwrite.com/api/v1/me" \
-H "Authorization: Bearer $ORBITWRITE_API_KEY"{
"organization": {
"id": "string",
"name": "string",
"slug": "string"
}
}Registers a target URL to receive a given event for this workspace. Idempotent: re-subscribing the same (event, URL) returns the existing subscription.
An API key or OAuth access token as a bearer token.
eventstringRequiredThe Orbitwrite activity a Zap subscribes to.
"post_published""post_failed""approval_requested""approval_decided""account_needs_reconnect"targetUrlstringRequiredThe URL to POST the event payload to (Zapier catch hook).
Format uri.
200ZapierSubscriptionThe created (or existing) subscription id
idstringRequiredcurl -X POST "https://orbitwrite.com/api/v1/hooks" \
-H "Authorization: Bearer $ORBITWRITE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"event": "post_published",
"targetUrl": "https://example.com"
}'{
"id": "string"
}Removes a subscription. Called by Zapier when a Zap is turned off.
An API key or OAuth access token as a bearer token.
idstringRequired200objectSubscription removed (or already absent)
okbooleanRequiredcurl -X DELETE "https://orbitwrite.com/api/v1/hooks/{id}" \
-H "Authorization: Bearer $ORBITWRITE_API_KEY"{
"ok": true
}Returns recent posts in the workspace shaped as the given trigger's payload, so a Zap's 'test trigger' step has realistic data. May be empty for a new workspace.
An API key or OAuth access token as a bearer token.
eventstringRequiredThe Orbitwrite activity a Zap subscribes to.
"post_published""post_failed""approval_requested""approval_decided""account_needs_reconnect"limitintegerBetween 1 and 25. Defaults to 3.
200ZapierRecentEventsRecent event samples, newest first
eventsobject[]Requiredcurl -X GET "https://orbitwrite.com/api/v1/events/recent?event=event" \
-H "Authorization: Bearer $ORBITWRITE_API_KEY"{
"events": [
{}
]
}Receives TikTok's post.publish.* events. Authenticated by TikTok's own TikTok-Signature header rather than by a session or key. Registered as the app's callback URL in the TikTok developer portal.
None. This endpoint is public.
curl -X POST "https://orbitwrite.com/api/v1/integrations/tiktok/webhook" \
-H "Authorization: Bearer $ORBITWRITE_API_KEY"{
"ok": true
}Receives Resend's email.* delivery events and records them against the sent message. Authenticated by Resend's Svix signature (svix-id, svix-timestamp, svix-signature) rather than by a session or key. Registered in the Resend dashboard.
None. This endpoint is public.
curl -X POST "https://orbitwrite.com/api/v1/webhooks/resend" \
-H "Authorization: Bearer $ORBITWRITE_API_KEY"{
"ok": true
}