Tickler API

GET /

Response:

• Status code 200
• Headers: []

• Supported content types are:

  • text/html;charset=utf-8
  • text/html
• Example (text/html;charset=utf-8, text/html):

Documentation (In HTML).

POST /

Authentication

This part of the API is protected by JSON Web Tokens (JWTs)

Clients must supply the following data A JWT Token signed with this server's key

Request:

• Supported content types are:

  • application/json

• Example (application/json):

{
    "old-passphrase": "Example Text",
    "new-passphrase": "Example Text"
}

Response:

• Status code 204
• Headers: []

• Supported content types are:

  • application/json;charset=utf-8
  • application/json
• Example (application/json;charset=utf-8, application/json):

DELETE /account

Authentication

This part of the API is protected by JSON Web Tokens (JWTs)

Clients must supply the following data A JWT Token signed with this server's key

Response:

• Status code 200
• Headers: []

• Supported content types are:

  • application/json
• Response body as below.

GET /account

Authentication

This part of the API is protected by JSON Web Tokens (JWTs)

Clients must supply the following data A JWT Token signed with this server's key

Response:

• Status code 200
• Headers: []

• Supported content types are:

  • application/json
• Example (application/json):

{
    "status": {
        "status": "not-paid",
        "items-left": 42
    },
    "admin": false,
    "uuid": "00000000-0000-0000-0000-000000000000",
    "created": "2018-02-10T00:00:42Z",
    "tickler-item-count": 42,
    "username": "Example Text",
    "last-login": null,
    "triggered-item-count": 42
}

• Example (application/json):

{
    "status": {
        "status": "paid",
        "until": "2018-02-10T00:00:42Z"
    },
    "admin": false,
    "uuid": "00000000-0000-0000-0000-000000000000",
    "created": "2018-02-10T00:00:42Z",
    "tickler-item-count": 42,
    "username": "Example Text",
    "last-login": null,
    "triggered-item-count": 42
}

• Example (application/json):

{
    "status": {
        "status": "not-paid",
        "items-left": 42
    },
    "admin": false,
    "uuid": "00000000-0000-0000-0000-000000000000",
    "created": "2018-02-10T00:00:42Z",
    "tickler-item-count": 42,
    "username": "Example Text",
    "last-login": "2018-02-10T00:00:42Z",
    "triggered-item-count": 42
}

• Example (application/json):

{
    "status": {
        "status": "not-paid",
        "items-left": 42
    },
    "admin": true,
    "uuid": "00000000-0000-0000-0000-000000000000",
    "created": "2018-02-10T00:00:42Z",
    "tickler-item-count": 42,
    "username": "Example Text",
    "last-login": null,
    "triggered-item-count": 42
}

• Example (application/json):

{
    "status": {
        "status": "paid",
        "until": "2018-02-10T00:00:42Z"
    },
    "admin": false,
    "uuid": "00000000-0000-0000-0000-000000000000",
    "created": "2018-02-10T00:00:42Z",
    "tickler-item-count": 42,
    "username": "Example Text",
    "last-login": "2018-02-10T00:00:42Z",
    "triggered-item-count": 42
}

GET /account/settings

Authentication

This part of the API is protected by JSON Web Tokens (JWTs)

Clients must supply the following data A JWT Token signed with this server's key

Response:

• Status code 200
• Headers: []

• Supported content types are:

  • application/json
• Response body as below.

{
    "timezone": {
        "offset": 0,
        "name": "UTC",
        "summer": false
    }
}

PUT /account/settings

Authentication

This part of the API is protected by JSON Web Tokens (JWTs)

Clients must supply the following data A JWT Token signed with this server's key

Request:

• Supported content types are:

  • application/json

• Example (application/json):

{
    "timezone": {
        "offset": 0,
        "name": "UTC",
        "summer": false
    }
}

Response:

• Status code 200
• Headers: []

• Supported content types are:

  • application/json
• Response body as below.

POST /login

Request:

• Supported content types are:

  • application/json

• Example (application/json):

{
    "username": "Example Text",
    "password": "Example Text"
}

Response:

• Status code 204
• Headers: [("Set-Cookie","Example Text")]

• Supported content types are:

  • application/json;charset=utf-8
  • application/json
• Example (application/json;charset=utf-8, application/json):

GET /loopers

Response:

• Status code 200
• Headers: []

• Supported content types are:

  • application/json
• Example (application/json):

{
    "stripeEventsRetrierLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "triggeredEmailSchedulerLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "triggererLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "stripeEventsFetcherLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "triggeredEmailConverterLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "triggeredIntrayItemSenderLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "adminNotificationEmailConverterLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "emailerLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "triggeredIntrayItemSchedulerLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "verificationEmailConverterLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    }
}

• Example (application/json):

{
    "stripeEventsRetrierLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": 42
    },
    "triggeredEmailSchedulerLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "triggererLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "stripeEventsFetcherLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "triggeredEmailConverterLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "triggeredIntrayItemSenderLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "adminNotificationEmailConverterLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "emailerLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "triggeredIntrayItemSchedulerLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "verificationEmailConverterLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    }
}

• Example (application/json):

{
    "stripeEventsRetrierLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "triggeredEmailSchedulerLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "triggererLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "stripeEventsFetcherLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "triggeredEmailConverterLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "triggeredIntrayItemSenderLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": 42
    },
    "adminNotificationEmailConverterLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "emailerLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "triggeredIntrayItemSchedulerLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "verificationEmailConverterLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    }
}

• Example (application/json):

{
    "stripeEventsRetrierLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "triggeredEmailSchedulerLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "triggererLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "stripeEventsFetcherLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "triggeredEmailConverterLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": 42
    },
    "triggeredIntrayItemSenderLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "adminNotificationEmailConverterLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "emailerLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "triggeredIntrayItemSchedulerLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "verificationEmailConverterLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    }
}

• Example (application/json):

{
    "stripeEventsRetrierLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": 42
    },
    "triggeredEmailSchedulerLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "triggererLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "stripeEventsFetcherLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "triggeredEmailConverterLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "triggeredIntrayItemSenderLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": 42
    },
    "adminNotificationEmailConverterLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "emailerLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "triggeredIntrayItemSchedulerLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    },
    "verificationEmailConverterLooperInfo": {
        "looperInfoPeriod": null,
        "looperInfoStatus": {
            "tag": "LooperStatusDisabled"
        },
        "looperInfoRetryDelay": null,
        "looperInfoRetryAmount": null
    }
}

GET /pricing

Response:

• Status code 200
• Headers: []

• Supported content types are:

  • application/json
• Example (application/json):

null

• Example (application/json):

{
    "trial-period": 30,
    "plan": "plan_FiN2Zsdv0DP0kh",
    "max-items-free": 5,
    "publishable-key": "pk_test_zV5qVP1IQTjE9QYulRZpfD8C00cqGOnQ91",
    "currency": "chf",
    "price": 100
}

POST /register

Request:

• Supported content types are:

  • application/json

• Example (application/json):

{
    "name": "Example Text",
    "password": "Example Text"
}

Response:

• Status code 200
• Headers: []

• Supported content types are:

  • application/json
• Response body as below.

POST /sync

Authentication

This part of the API is protected by JSON Web Tokens (JWTs)

Clients must supply the following data A JWT Token signed with this server's key

Request:

• Supported content types are:

  • application/json

• Example (application/json):

{
    "syncRequestTickles": {}
}

• Example (application/json):

{
    "syncRequestTickles": {
        "deleted": {
            "00000000-0000-0000-0000-000000000000": 0
        }
    }
}

• Example (application/json):

{
    "syncRequestTickles": {
        "synced": {
            "00000000-0000-0000-0000-000000000000": 0
        }
    }
}

• Example (application/json):

{
    "syncRequestTickles": {
        "changed": {
            "00000000-0000-0000-0000-000000000000": {
                "time": 0,
                "value": {
                    "contents": {
                        "scheduled-day": "2018-06-14",
                        "content": "Hello World!",
                        "recurrence": null,
                        "scheduled-time": null
                    },
                    "created": "2018-02-10T00:00:42Z"
                }
            }
        }
    }
}

• Example (application/json):

{
    "syncRequestTickles": {
        "deleted": {
            "00000000-0000-0000-0000-000000000000": 0
        },
        "synced": {
            "00000000-0000-0000-0000-000000000000": 0
        }
    }
}

Response:

• Status code 200
• Headers: []

• Supported content types are:

  • application/json
• Example (application/json):

{
    "syncResponseTickles": {}
}

• Example (application/json):

{
    "syncResponseTickles": {
        "conflict-server-deleted": [
            "00000000-0000-0000-0000-000000000000"
        ]
    }
}

• Example (application/json):

{
    "syncResponseTickles": {
        "server-added": {
            "00000000-0000-0000-0000-000000000000": {
                "time": 0,
                "value": {
                    "contents": {
                        "scheduled-day": "2018-06-14",
                        "content": "Hello World!",
                        "recurrence": null,
                        "scheduled-time": null
                    },
                    "created": "2018-02-10T00:00:42Z"
                }
            }
        }
    }
}

• Example (application/json):

{
    "syncResponseTickles": {
        "server-deleted": [
            "00000000-0000-0000-0000-000000000000"
        ]
    }
}

• Example (application/json):

{
    "syncResponseTickles": {
        "conflict-server-deleted": [
            "00000000-0000-0000-0000-000000000000"
        ],
        "server-added": {
            "00000000-0000-0000-0000-000000000000": {
                "time": 0,
                "value": {
                    "contents": {
                        "scheduled-day": "2018-06-14",
                        "content": "Hello World!",
                        "recurrence": null,
                        "scheduled-time": null
                    },
                    "created": "2018-02-10T00:00:42Z"
                }
            }
        }
    }
}

POST /tickler/item

Authentication

This part of the API is protected by JSON Web Tokens (JWTs)

Clients must supply the following data A JWT Token signed with this server's key

Request:

• Supported content types are:

  • application/json

• Example (application/json):

{
    "scheduled-day": "2018-06-14",
    "content": "Hello World!",
    "recurrence": null,
    "scheduled-time": null
}

• Every Day (application/json):

{
    "scheduled-day": "2018-06-14",
    "content": "Hello World!",
    "recurrence": {
        "every-x-days": {
            "days": 1,
            "time-of-day": null
        }
    },
    "scheduled-time": null
}

• Example (application/json):

{
    "scheduled-day": "2018-06-14",
    "content": "Hello World!",
    "recurrence": null,
    "scheduled-time": "12:00:00"
}

• Every Month (application/json):

{
    "scheduled-day": "2018-06-14",
    "content": "Hello World!",
    "recurrence": {
        "every-x-months": {
            "months": 1,
            "day": null,
            "time-of-day": null
        }
    },
    "scheduled-time": null
}

• Every Day (application/json):

{
    "scheduled-day": "2018-06-14",
    "content": "Hello World!",
    "recurrence": {
        "every-x-days": {
            "days": 1,
            "time-of-day": null
        }
    },
    "scheduled-time": "12:00:00"
}

Response:

• Status code 200
• Headers: []

• Supported content types are:

  • application/json
• Response body as below.

"00000000-0000-0000-0000-000000000000"

DELETE /tickler/item/delete/:id

Authentication

This part of the API is protected by JSON Web Tokens (JWTs)

Clients must supply the following data A JWT Token signed with this server's key

Captures:

• id: The UUID of the item

Response:

• Status code 200
• Headers: []

• Supported content types are:

  • application/json
• Response body as below.

POST /tickler/item/delete-triggereds

Authentication

This part of the API is protected by JSON Web Tokens (JWTs)

Clients must supply the following data A JWT Token signed with this server's key

Response:

• Status code 200
• Headers: []

• Supported content types are:

  • application/json
• Response body as below.

GET /tickler/item/info/:id

Authentication

This part of the API is protected by JSON Web Tokens (JWTs)

Clients must supply the following data A JWT Token signed with this server's key

Captures:

• id: The UUID of the item

Response:

• Status code 200
• Headers: []

• Supported content types are:

  • application/json
• Example (application/json):

{
    "contents": {
        "scheduled-day": "2018-06-14",
        "content": "Hello World!",
        "recurrence": null,
        "scheduled-time": null
    },
    "created": "2018-02-10T00:00:42Z",
    "triggered": null,
    "id": "00000000-0000-0000-0000-000000000000"
}

• Example (application/json):

{
    "contents": {
        "scheduled-day": "2018-06-14",
        "content": "Hello World!",
        "recurrence": null,
        "scheduled-time": null
    },
    "created": "2018-02-10T00:00:42Z",
    "triggered": {
        "triggeredInfoTriggered": "2018-02-10T00:00:42Z",
        "triggeredInfoTriggerTriggerAttempts": []
    },
    "id": "00000000-0000-0000-0000-000000000000"
}

• Every Day (application/json):

{
    "contents": {
        "scheduled-day": "2018-06-14",
        "content": "Hello World!",
        "recurrence": {
            "every-x-days": {
                "days": 1,
                "time-of-day": null
            }
        },
        "scheduled-time": null
    },
    "created": "2018-02-10T00:00:42Z",
    "triggered": null,
    "id": "00000000-0000-0000-0000-000000000000"
}

• Example (application/json):

{
    "contents": {
        "scheduled-day": "2018-06-14",
        "content": "Hello World!",
        "recurrence": null,
        "scheduled-time": null
    },
    "created": "2018-02-10T00:00:42Z",
    "triggered": {
        "triggeredInfoTriggered": "2018-02-10T00:00:42Z",
        "triggeredInfoTriggerTriggerAttempts": [
            {
                "tag": "EmailTriggerAttempt",
                "contents": [
                    "00000000-0000-0000-0000-000000000000",
                    {
                        "tag": "EmailResultSent"
                    }
                ]
            }
        ]
    },
    "id": "00000000-0000-0000-0000-000000000000"
}

• Every Day (application/json):

{
    "contents": {
        "scheduled-day": "2018-06-14",
        "content": "Hello World!",
        "recurrence": {
            "every-x-days": {
                "days": 1,
                "time-of-day": null
            }
        },
        "scheduled-time": null
    },
    "created": "2018-02-10T00:00:42Z",
    "triggered": {
        "triggeredInfoTriggered": "2018-02-10T00:00:42Z",
        "triggeredInfoTriggerTriggerAttempts": []
    },
    "id": "00000000-0000-0000-0000-000000000000"
}

POST /tickler/item/info/:id

Authentication

This part of the API is protected by JSON Web Tokens (JWTs)

Clients must supply the following data A JWT Token signed with this server's key

Captures:

• id: The UUID of the item

Request:

• Supported content types are:

  • application/json

• Example (application/json):

{
    "scheduled-day": "2018-06-14",
    "content": "Hello World!",
    "recurrence": null,
    "scheduled-time": null
}

• Every Day (application/json):

{
    "scheduled-day": "2018-06-14",
    "content": "Hello World!",
    "recurrence": {
        "every-x-days": {
            "days": 1,
            "time-of-day": null
        }
    },
    "scheduled-time": null
}

• Example (application/json):

{
    "scheduled-day": "2018-06-14",
    "content": "Hello World!",
    "recurrence": null,
    "scheduled-time": "12:00:00"
}

• Every Month (application/json):

{
    "scheduled-day": "2018-06-14",
    "content": "Hello World!",
    "recurrence": {
        "every-x-months": {
            "months": 1,
            "day": null,
            "time-of-day": null
        }
    },
    "scheduled-time": null
}

• Every Day (application/json):

{
    "scheduled-day": "2018-06-14",
    "content": "Hello World!",
    "recurrence": {
        "every-x-days": {
            "days": 1,
            "time-of-day": null
        }
    },
    "scheduled-time": "12:00:00"
}

Response:

• Status code 200
• Headers: []

• Supported content types are:

  • application/json
• Response body as below.

POST /tickler/item/retry

Authentication

This part of the API is protected by JSON Web Tokens (JWTs)

Clients must supply the following data A JWT Token signed with this server's key

Request:

• Supported content types are:

  • application/json

• Example (application/json):

[]

• Example (application/json):

[
    "00000000-0000-0000-0000-000000000000"
]

• Example (application/json):

[
    "00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000000"
]

• Example (application/json):

[
    "00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000000"
]

• Example (application/json):

[
    "00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000000"
]

Response:

• Status code 200
• Headers: []

• Supported content types are:

  • application/json
• Response body as below.

GET /tickler/items

Authentication

This part of the API is protected by JSON Web Tokens (JWTs)

Clients must supply the following data A JWT Token signed with this server's key

GET Parameters:

• filter
  • Values: OnlyUntriggered, OnlyTriggered
  • Description: Optionally specify a filter on the items

Response:

• Status code 200
• Headers: []

• Supported content types are:

  • application/json
• Example (application/json):

[]

• Example (application/json):

[
    {
        "contents": {
            "scheduled-day": "2018-06-14",
            "content": "Hello World!",
            "recurrence": null,
            "scheduled-time": null
        },
        "created": "2018-02-10T00:00:42Z",
        "triggered": null,
        "id": "00000000-0000-0000-0000-000000000000"
    }
]

• Example (application/json):

[
    {
        "contents": {
            "scheduled-day": "2018-06-14",
            "content": "Hello World!",
            "recurrence": null,
            "scheduled-time": null
        },
        "created": "2018-02-10T00:00:42Z",
        "triggered": null,
        "id": "00000000-0000-0000-0000-000000000000"
    },
    {
        "contents": {
            "scheduled-day": "2018-06-14",
            "content": "Hello World!",
            "recurrence": null,
            "scheduled-time": null
        },
        "created": "2018-02-10T00:00:42Z",
        "triggered": null,
        "id": "00000000-0000-0000-0000-000000000000"
    }
]

• Example (application/json):

[
    {
        "contents": {
            "scheduled-day": "2018-06-14",
            "content": "Hello World!",
            "recurrence": null,
            "scheduled-time": null
        },
        "created": "2018-02-10T00:00:42Z",
        "triggered": {
            "triggeredInfoTriggered": "2018-02-10T00:00:42Z",
            "triggeredInfoTriggerTriggerAttempts": []
        },
        "id": "00000000-0000-0000-0000-000000000000"
    }
]

• Example (application/json):

[
    {
        "contents": {
            "scheduled-day": "2018-06-14",
            "content": "Hello World!",
            "recurrence": null,
            "scheduled-time": null
        },
        "created": "2018-02-10T00:00:42Z",
        "triggered": null,
        "id": "00000000-0000-0000-0000-000000000000"
    },
    {
        "contents": {
            "scheduled-day": "2018-06-14",
            "content": "Hello World!",
            "recurrence": null,
            "scheduled-time": null
        },
        "created": "2018-02-10T00:00:42Z",
        "triggered": null,
        "id": "00000000-0000-0000-0000-000000000000"
    },
    {
        "contents": {
            "scheduled-day": "2018-06-14",
            "content": "Hello World!",
            "recurrence": null,
            "scheduled-time": null
        },
        "created": "2018-02-10T00:00:42Z",
        "triggered": null,
        "id": "00000000-0000-0000-0000-000000000000"
    }
]

GET /tickler/uuids

Authentication

This part of the API is protected by JSON Web Tokens (JWTs)

Clients must supply the following data A JWT Token signed with this server's key

Response:

• Status code 200
• Headers: []

• Supported content types are:

  • application/json
• Example (application/json):

[]

• Example (application/json):

[
    "00000000-0000-0000-0000-000000000000"
]

• Example (application/json):

[
    "00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000000"
]

• Example (application/json):

[
    "00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000000"
]

• Example (application/json):

[
    "00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000000"
]

GET /trigger

Authentication

This part of the API is protected by JSON Web Tokens (JWTs)

Clients must supply the following data A JWT Token signed with this server's key

Response:

• Status code 200
• Headers: []

• Supported content types are:

  • application/json
• Example (application/json):

[]

• Example (application/json):

[
    {
        "uuid": "00000000-0000-0000-0000-000000000000",
        "info": {
            "typedTriggerInfoType": "email",
            "typedTriggerInfoValue": {
                "Here": "Be",
                "A": "Value"
            }
        }
    }
]

• Example (application/json):

[
    {
        "uuid": "00000000-0000-0000-0000-000000000000",
        "info": {
            "typedTriggerInfoType": "email",
            "typedTriggerInfoValue": {
                "Here": "Be",
                "A": "Value"
            }
        }
    },
    {
        "uuid": "00000000-0000-0000-0000-000000000000",
        "info": {
            "typedTriggerInfoType": "email",
            "typedTriggerInfoValue": {
                "Here": "Be",
                "A": "Value"
            }
        }
    }
]

• Example (application/json):

[
    {
        "uuid": "00000000-0000-0000-0000-000000000000",
        "info": {
            "typedTriggerInfoType": "intray",
            "typedTriggerInfoValue": {
                "Here": "Be",
                "A": "Value"
            }
        }
    }
]

• Example (application/json):

[
    {
        "uuid": "00000000-0000-0000-0000-000000000000",
        "info": {
            "typedTriggerInfoType": "email",
            "typedTriggerInfoValue": {
                "Here": "Be",
                "A": "Value"
            }
        }
    },
    {
        "uuid": "00000000-0000-0000-0000-000000000000",
        "info": {
            "typedTriggerInfoType": "email",
            "typedTriggerInfoValue": {
                "Here": "Be",
                "A": "Value"
            }
        }
    },
    {
        "uuid": "00000000-0000-0000-0000-000000000000",
        "info": {
            "typedTriggerInfoType": "email",
            "typedTriggerInfoValue": {
                "Here": "Be",
                "A": "Value"
            }
        }
    }
]

DELETE /trigger/delete/:id

Authentication

This part of the API is protected by JSON Web Tokens (JWTs)

Clients must supply the following data A JWT Token signed with this server's key

Captures:

• id: The UUID of the trigger

Response:

• Status code 200
• Headers: []

• Supported content types are:

  • application/json
• Response body as below.

POST /trigger/email

Authentication

This part of the API is protected by JSON Web Tokens (JWTs)

Clients must supply the following data A JWT Token signed with this server's key

Request:

• Supported content types are:

  • application/json

• Example (application/json):

{
    "addEmailTrigger": "user@example.com"
}

Response:

• Status code 200
• Headers: []

• Supported content types are:

  • application/json
• Response body as below.

"00000000-0000-0000-0000-000000000000"

POST /trigger/email/resend/:id

Authentication

This part of the API is protected by JSON Web Tokens (JWTs)

Clients must supply the following data A JWT Token signed with this server's key

Captures:

• id: The UUID of the trigger

Response:

• Status code 200
• Headers: []

• Supported content types are:

  • application/json
• Response body as below.

POST /trigger/email/verify/:id/:key

Authentication

This part of the API is protected by JSON Web Tokens (JWTs)

Clients must supply the following data A JWT Token signed with this server's key

Captures:

• id: The UUID of the trigger
• key: The verification key that was sent in the verification email

Response:

• Status code 200
• Headers: []

• Supported content types are:

  • application/json
• Response body as below.

GET /trigger/info/:id

Authentication

This part of the API is protected by JSON Web Tokens (JWTs)

Clients must supply the following data A JWT Token signed with this server's key

Captures:

• id: The UUID of the trigger

Response:

• Status code 200
• Headers: []

• Supported content types are:

  • application/json
• Example (application/json):

{
    "uuid": "00000000-0000-0000-0000-000000000000",
    "info": {
        "typedTriggerInfoType": "email",
        "typedTriggerInfoValue": {
            "Here": "Be",
            "A": "Value"
        }
    }
}

• Example (application/json):

{
    "uuid": "00000000-0000-0000-0000-000000000000",
    "info": {
        "typedTriggerInfoType": "intray",
        "typedTriggerInfoValue": {
            "Here": "Be",
            "A": "Value"
        }
    }
}

POST /trigger/intray

Authentication

This part of the API is protected by JSON Web Tokens (JWTs)

Clients must supply the following data A JWT Token signed with this server's key

Request:

• Supported content types are:

  • application/json

• Example (application/json):

{
    "addIntrayTriggerUrl": "https://tickler.cs-syd.eu:8000",
    "addIntrayTriggerUsername": "Example Text",
    "addIntrayTriggerAccessKey": "4a921dd6b8edbfba19ac55b80ca6bbfd"
}

Response:

• Status code 200
• Headers: []

• Supported content types are:

  • application/json
• Example (application/json):

{
    "Left": "Example Text"
}

• Example (application/json):

{
    "Right": "00000000-0000-0000-0000-000000000000"
}

© CS SYD. Tom Sydney Kerckhove | Technical Leader | Speaker | Coach.

sydmuhaha@cs-syd.eu