Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Routine Run connections Events API
version: '1'
description: An address made in the Routine Run app (Settings › Connections) starts or moves a routine on the one iPhone that made it. https://routinerun.com/developers
servers:
- url: https://api.routinerun.com/v1/in/{connection}
variables:
connection:
default: 00000000-0000-0000-0000-000000000000
description: The connection's id, from its address.
security:
- secret: []
tags:
- name: Events
paths:
/events:
post:
summary: Hand over an event
description: 'What Handle Event does in Shortcuts: the person''s Sources decide which routine starts.'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- title
properties:
title:
type: string
description: What happened.
body:
type: string
description: More of it.
source:
type: string
description: Who sent it. The connection's name if left out.
externalId:
type: string
description: The sender's own id; a duplicate is recognised by it.
routine:
type: string
description: A routine to start, by name or id, instead of letting Sources decide.
fields:
type: object
additionalProperties:
type: string
responses:
'202':
description: Handed to Apple for the phone. Not yet done.
content:
application/json:
schema:
$ref: '#/components/schemas/Accepted'
'400':
$ref: '#/components/responses/Error'
'401':
$ref: '#/components/responses/Error'
'409':
$ref: '#/components/responses/Error'
'410':
$ref: '#/components/responses/Error'
'413':
$ref: '#/components/responses/Error'
'429':
$ref: '#/components/responses/Error'
tags:
- Events
operationId: postEvents
x-operation-id-source: derived
components:
schemas:
Accepted:
type: object
properties:
status:
type: string
enum:
- accepted
Error:
type: object
properties:
error:
type: string
responses:
Error:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'