document webhook endpoints #242
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for grist-help-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
paulfitz
force-pushed
the
webhook-endpoints
branch
from
7d709c4
to
9fa27da
Compare
paulfitz
changed the title
There was a problem hiding this comment.
in GET there is:
[
{
"id": "xxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx",
"fields": {
"name": "new-project-email",
"memo": "Send an email when a project is added",
"url": "https://example.com/webhook/123",
"enabled": true,
"eventTypes": [
"add",
"update"
],
"isReadyColumn": null,
"tableId": "Projects",
"unsubscribeKey": "string"
},
"usage": {
"numWaiting": 0,
"status": "idle",
"updatedTime": 1685637500424,
"lastSuccessTime": 1685637500424,
"lastFailureTime": 1685637500424,
"lastErrorMessage": null,
"lastHttpStatus": 200,
"lastEventBatch": {
"$ref": null,
"size": 1,
"attempts": 1,
"errorMessage": null,
"httpStatus": 200,
"status": "success"
}
}
}
]
and it should be:
{
"webhooks": [
{
"id": "xxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx",
"fields": {
"name": "new-project-email",
"memo": "Send an email when a project is added",
"url": "https://example.com/webhook/123",
"enabled": true,
"eventTypes": [
"add",
"update"
],
"isReadyColumn": null,
"tableId": "Projects",
"unsubscribeKey": "string"
},
"usage": {
"numWaiting": 0,
"status": "idle",
"updatedTime": 1685637500424,
"lastSuccessTime": 1685637500424,
"lastFailureTime": 1685637500424,
"lastErrorMessage": null,
"lastHttpStatus": 200,
"lastEventBatch": {
"$ref": null,
"size": 1,
"attempts": 1,
"errorMessage": null,
"httpStatus": 200,
"status": "success"
}
}
}
]
}
There was a problem hiding this comment.
in POST:
there is:
{
"webhooks": [
{
"name": "new-project-email",
"memo": "Send an email when a project is added",
"url": "https://example.com/webhook/123",
"enabled": true,
"eventTypes": [
"add",
"update"
],
"isReadyColumn": null,
"tableId": "Projects"
}
]
}
and should be:
"webhooks": [
{
"fields": {
"name": "new-project-email",
"memo": "Send an email when a project is added",
"url": "https://example.com/webhook/123",
"enabled": true,
"eventTypes": [
"add",
"update"
],
"isReadyColumn": null,
"tableId": "Projects"
}
]
}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Start documenting endpoints related to webhooks, replacing the older unofficial _subscribe/_unsubscribe (see gristlabs/grist-core#76 (comment))