Create a new quest
POST/quests
This endpoint creates a new quest
Request
- application/json
Body
required
Quest to be created
a unique name for the quest
the primary owner of the quest, an id from the buddy-auth service (e.g. GET /user)
a unique name for the quest
a vanity name for the quest
Possible values: [active, inactive]
the status of the quest
config
object
required
the number of points the quest is worth
Possible values: [none, hourly, daily, weekly, monthly, yearly]
how often the quest can be repeated
the maximum time to complete the quest in hours
whether to use the last success as the epoch for the next repeat
offset from UTC e.g. -07:00
the number of times the quest can be repeated, 0 for unlimited
trigger
object
the type of trigger (e.g. webhook, cron, social)
the provider of the trigger (e.g. twitter, github, cron)
the arguments for the trigger, see documentation for each provider
Responses
- 200
Quest created
- application/json
- Schema
- Example (from schema)
Schema
a unique name for the quest
the primary owner of the quest, an id from the buddy-auth service (e.g. GET /user)
a unique name for the quest
a vanity name for the quest
Possible values: [active, inactive]
the status of the quest
config
object
required
the number of points the quest is worth
Possible values: [none, hourly, daily, weekly, monthly, yearly]
how often the quest can be repeated
the maximum time to complete the quest in hours
whether to use the last success as the epoch for the next repeat
offset from UTC e.g. -07:00
the number of times the quest can be repeated, 0 for unlimited
trigger
object
the type of trigger (e.g. webhook, cron, social)
the provider of the trigger (e.g. twitter, github, cron)
the arguments for the trigger, see documentation for each provider
{
"name": "string",
"owner": "string",
"image": "string",
"displayName": "string",
"status": "active",
"config": {
"pointValue": 0,
"repeatFrequency": "none",
"MaximumTimeToComplete": 0,
"useLastSuccessAsEpoch": true,
"timezone": "string",
"repeatLimit": 0
},
"trigger": {
"type": "string",
"provider": "string",
"args": {}
}
}