API docs by Redocly

FollowMyPatient API (1.0.0)

Download OpenAPI specification:Download

E-mail: david@blcks.io

API integration for FollowMyPatient systems.

How to Start

  1. Register in the FMP system or log in here
  2. Generate an apiKey on FMP Profile
  3. Set the basic voices here
  4. Adds questions to the system here
  5. Creates your first Flow here

Flow

A Flow is a structured sequence of questions and end actions. End actions are executed at the conclusion of the flow, such as sending an SMS or email, or making an API call. Within a flow, you can create scenarios and assign points to possible answers. These points help determine the appropriate course of action when the flow reaches a specific point. Assigning points is optional, but it allows for more granular decision-making based on user responses.

Get Flows By Partner

Returns all Flows for the Partner based on their API KEY

Request Body schema: application/json
apiKey
required
string

Responses

Request samples

Content type
application/json
{
  • "apiKey": "your_api_key"
}

Response samples

Content type
application/json
{
  • "errorMsg": "string",
  • "success": true,
  • "flows": [
    ]
}

Set Flow End Action URL

Sets a callback URL to call with POST method after the event has run and send data back in JSON. More on callbacks part.

Request Body schema: application/json
apiKey
required
string
flowId
required
string
endActionURL
required
string

Responses

Callbacks

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "flowId": "string",
  • "success": true,
  • "errorMsg": "string"
}

Callback payload samples

Callback
POST: https://example.com/callbackUrl
Content type
application/json
{
  • "eventId": "string",
  • "originalEventId": "string",
  • "client": {
    },
  • "status": "Active",
  • "flowId": "string"
}

Event

An Event triggers the execution of a flow by specifying a client and a scheduled time. Events can be configured to run the flow either once or on a recurring basis—daily, weekly, yearly, or at any other interval. This allows you to automate the flow's execution according to your desired schedule.

Set Event

Set Event

Request Body schema: application/json
apiKey
required
string
flowId
required
string
required
object
date
required
string <date-time>

ISO 8601 standard

repeatCount
required
integer
Default: 0

How many times should repeat based on repeatType

isInfinite
required
boolean
Default: false

If true, it will repeat this event based on the repeatType until it is turned off.

repeatType
required
string
Enum: "Daily" "Weekly" "Monthly" "Yearly"

Responses

Request samples

Content type
application/json
{
  • "apiKey": "your_api_key",
  • "flowId": "flow_id",
  • "client": {
    },
  • "date": "2024-05-22T13:12:01.470Z",
  • "repeatCount": 0,
  • "isInfinite": false,
  • "repeatType": "Daily"
}

Response samples

Content type
application/json
{
  • "eventId": "string",
  • "success": true,
  • "errorMsg": "string"
}

Get Event Status

Returns the status of an event and, if the status is "Completed", returns the questions and answers too

Request Body schema: application/json
apiKey
required
string
eventId
required
string

Responses

Request samples

Content type
application/json
{
  • "apiKey": "your_api_key",
  • "eventId": "event_id"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "errorMsg": "string",
  • "status": "Active",
  • "eventId": "string",
  • "answers": [
    ]
}