mirror of
https://github.com/gristlabs/grist-core.git
synced 2024-10-27 20:44:07 +00:00
a9f4cfde90
Summary:
introduces POST /api/docs/{docId}/webhooks and DELETE /api/docs/{docId}/webhooks/{webhookId} on place of old _subscribe and _unsubscribe endpoints.
Remove checking for unsubscribeKey while deleting webhook - only owner can delete webhook using DELETE endpoint. subscription key is still needed for _unsubscribe endpoint.
old _unsubscribe and _subscribe endpoints are still active and work as before - no changes there.
Posting schema:
```
POST /api/docs/[docId]/webhooks
```
Request Body:
```
{
"webhooks": [
{
"fields": {
"url": "https://webhook.site/3bd02246-f122-445e-ba7f-bf5ea5bb6eb1",
"eventTypes": [
"add",
"update"
],
"enabled": true,
"name": "WebhookName",
"memo": "just a text",
"tableId": "Table1"
}
},
{
"fields": {
"url": "https://webhook.site/3bd02246-f122-445e-ba7f-bf5ea5bb6eb2",
"eventTypes": [
"add",
],
"enabled": true,
"name": "OtherWebhookName",
"memo": "just a text",
"tableId": "Table1"
}
}
]
}
```
Expected response: WebhookId for each webhook posted:
```
{
"webhooks": [
{
"id": "85c77108-f1e1-4217-a50d-acd1c5996da2"
},
{
"id": "d87a6402-cfd7-4822-878c-657308fcc8c3"
}
]
}
```
Deleting webhooks:
```
DELETE api/docs/[docId]/webhooks/[webhookId]
```
there is no payload in DELETE request. Therefore only one webhook can be deleted at once
Response:
```
{
"success": true
}
```
Test Plan: Old unit test improved to handle new endpoints, and one more added to check if endpoints are in fact created/removed
Reviewers: alexmojaki
Reviewed By: alexmojaki
Subscribers: paulfitz, alexmojaki
Differential Revision: https://phab.getgrist.com/D3916
102 lines
2.8 KiB
TypeScript
102 lines
2.8 KiB
TypeScript
/**
|
|
* This module was automatically generated by `ts-interface-builder`
|
|
*/
|
|
import * as t from "ts-interface-checker";
|
|
// tslint:disable:object-literal-key-quotes
|
|
|
|
export const WebhookFields = t.iface([], {
|
|
"url": "string",
|
|
"eventTypes": t.array(t.union(t.lit("add"), t.lit("update"))),
|
|
"tableId": "string",
|
|
"enabled": t.opt("boolean"),
|
|
"isReadyColumn": t.opt(t.union("string", "null")),
|
|
"name": t.opt("string"),
|
|
"memo": t.opt("string"),
|
|
});
|
|
|
|
export const Webhook = t.iface([], {
|
|
"fields": "WebhookFields",
|
|
});
|
|
|
|
export const WebhookBatchStatus = t.union(t.lit('success'), t.lit('failure'), t.lit('rejected'));
|
|
|
|
export const WebhookStatus = t.union(t.lit('idle'), t.lit('sending'), t.lit('retrying'), t.lit('postponed'), t.lit('error'), t.lit('invalid'));
|
|
|
|
export const WebhookSubscribe = t.iface([], {
|
|
"url": "string",
|
|
"eventTypes": t.array(t.union(t.lit("add"), t.lit("update"))),
|
|
"enabled": t.opt("boolean"),
|
|
"isReadyColumn": t.opt(t.union("string", "null")),
|
|
"name": t.opt("string"),
|
|
"memo": t.opt("string"),
|
|
});
|
|
|
|
export const WebhookSubscribeCollection = t.iface([], {
|
|
"webhooks": t.array("Webhook"),
|
|
});
|
|
|
|
export const WebhookSummary = t.iface([], {
|
|
"id": "string",
|
|
"fields": t.iface([], {
|
|
"url": "string",
|
|
"unsubscribeKey": "string",
|
|
"eventTypes": t.array("string"),
|
|
"isReadyColumn": t.union("string", "null"),
|
|
"tableId": "string",
|
|
"enabled": "boolean",
|
|
"name": "string",
|
|
"memo": "string",
|
|
}),
|
|
"usage": t.union("WebhookUsage", "null"),
|
|
});
|
|
|
|
export const WebhookUpdate = t.iface([], {
|
|
"id": "string",
|
|
"fields": "WebhookPatch",
|
|
});
|
|
|
|
export const WebhookPatch = t.iface([], {
|
|
"url": t.opt("string"),
|
|
"eventTypes": t.opt(t.array(t.union(t.lit("add"), t.lit("update")))),
|
|
"tableId": t.opt("string"),
|
|
"enabled": t.opt("boolean"),
|
|
"isReadyColumn": t.opt(t.union("string", "null")),
|
|
"name": t.opt("string"),
|
|
"memo": t.opt("string"),
|
|
});
|
|
|
|
export const WebhookUsage = t.iface([], {
|
|
"numWaiting": "number",
|
|
"status": "WebhookStatus",
|
|
"updatedTime": t.opt(t.union("number", "null")),
|
|
"lastSuccessTime": t.opt(t.union("number", "null")),
|
|
"lastFailureTime": t.opt(t.union("number", "null")),
|
|
"lastErrorMessage": t.opt(t.union("string", "null")),
|
|
"lastHttpStatus": t.opt(t.union("number", "null")),
|
|
"lastEventBatch": t.opt(t.union("null", t.iface([], {
|
|
"size": "number",
|
|
"errorMessage": t.union("string", "null"),
|
|
"httpStatus": t.union("number", "null"),
|
|
"status": "WebhookBatchStatus",
|
|
"attempts": "number",
|
|
}))),
|
|
"numSuccess": t.opt(t.iface([], {
|
|
"pastHour": "number",
|
|
"past24Hours": "number",
|
|
})),
|
|
});
|
|
|
|
const exportedTypeSuite: t.ITypeSuite = {
|
|
WebhookFields,
|
|
Webhook,
|
|
WebhookBatchStatus,
|
|
WebhookStatus,
|
|
WebhookSubscribe,
|
|
WebhookSubscribeCollection,
|
|
WebhookSummary,
|
|
WebhookUpdate,
|
|
WebhookPatch,
|
|
WebhookUsage,
|
|
};
|
|
export default exportedTypeSuite;
|