Skip to content

Support webhook in the coderoad cli #85

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 4, 2021
Merged

Support webhook in the coderoad cli #85

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7eba915
add webhook typings
ShMcK Sep 4, 2021
61f23ef
add webhook schema
ShMcK Sep 4, 2021
99b3dbe
validate webhook schema
ShMcK Sep 4, 2021
dec2296
add webhook config tests
ShMcK Sep 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
add webhook schema 
Signed-off-by: shmck <shawn.j.mckay@gmail.com>
  • Loading branch information
@ShMcK
ShMcK committed Sep 4, 2021
commit 61f23efd5cab31d4cdd82b9a57a09e39b51e6277
46 changes: 46 additions & 0 deletions src/schema/skeleton.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,52 @@ export default {
}
}
},
webhook: {
type: 'object',
description: 'An optional configuration for webhooks triggered by events such as init, step/level/tutorial complete',
properties: {
url: {
type: 'string',
description: 'URL for POST restful webhook request',
examples: ['https://example.com/webhook']
},
events: {
type: 'object',
description: 'An object of events to trigger on',
properties: {
init: {
type: 'boolean',
description:
'An event triggered on tutorial startup. Sends tutorialId',
},
reset: {
type: 'boolean',
description:
'An event triggered on reset of a tutorial. Sends tutorialId',
},
step_complete: {
type: 'boolean',
description:
'An event triggered on completion of a step. Sends tutorialId, levelId & stepId',
},
level_complete: {
step_complete: {
type: 'boolean',
description:
'An event triggered on completion of a level. Sends tutorialId & levelId',
},
},
tutorial_complete: {
step_complete: {
type: 'boolean',
description:
'An event triggered on completion of a tutorial. Sends tutorialId',
},
}
}
},
}
},
additionalProperties: false,
required: ['testRunner', 'repo']
},
Expand Down
46 changes: 46 additions & 0 deletions src/schema/tutorial.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,52 @@ export default {
}
}
},
webhook: {
type: 'object',
description: 'An optional configuration for webhooks triggered by events such as init, step/level/tutorial complete',
properties: {
url: {
type: 'string',
description: 'URL for POST restful webhook request',
examples: ['https://example.com/webhook']
},
events: {
type: 'object',
description: 'An object of events to trigger on',
properties: {
init: {
type: 'boolean',
description:
'An event triggered on tutorial startup. Sends tutorialId',
},
reset: {
type: 'boolean',
description:
'An event triggered on reset of a tutorial. Sends tutorialId',
},
step_complete: {
type: 'boolean',
description:
'An event triggered on completion of a step. Sends tutorialId, levelId & stepId',
},
level_complete: {
step_complete: {
type: 'boolean',
description:
'An event triggered on completion of a level. Sends tutorialId & levelId',
},
},
tutorial_complete: {
step_complete: {
type: 'boolean',
description:
'An event triggered on completion of a tutorial. Sends tutorialId',
},
}
}
},
}
},
additionalProperties: false,
required: ['testRunner', 'repo']
},
Expand Down