mirror of
https://github.com/gristlabs/grist-core.git
synced 2024-09-28 20:10:46 +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
92 lines
2.1 KiB
TypeScript
92 lines
2.1 KiB
TypeScript
export interface WebhookSubscribeCollection{
|
|
webhooks: Array<Webhook>
|
|
}
|
|
|
|
export interface Webhook {
|
|
fields: WebhookFields;
|
|
}
|
|
|
|
export interface WebhookFields {
|
|
url: string;
|
|
eventTypes: Array<"add"|"update">;
|
|
tableId: string;
|
|
enabled?: boolean;
|
|
isReadyColumn?: string|null;
|
|
name?: string;
|
|
memo?: string;
|
|
}
|
|
|
|
// Union discriminated by type
|
|
export type WebhookBatchStatus = 'success'|'failure'|'rejected';
|
|
export type WebhookStatus = 'idle'|'sending'|'retrying'|'postponed'|'error'|'invalid';
|
|
|
|
|
|
// WebhookSubscribe should be `Omit<WebhookFields, 'tableId'>` (because subscribe endpoint read
|
|
// tableId from the url) but generics are not yet supported by ts-interface-builder
|
|
export interface WebhookSubscribe {
|
|
url: string;
|
|
eventTypes: Array<"add"|"update">;
|
|
enabled?: boolean;
|
|
isReadyColumn?: string|null;
|
|
name?: string;
|
|
memo?: string;
|
|
}
|
|
|
|
|
|
|
|
export interface WebhookSummary {
|
|
id: string;
|
|
fields: {
|
|
url: string;
|
|
unsubscribeKey: string;
|
|
eventTypes: string[];
|
|
isReadyColumn: string|null;
|
|
tableId: string;
|
|
enabled: boolean;
|
|
name: string;
|
|
memo: string;
|
|
},
|
|
usage: WebhookUsage|null,
|
|
}
|
|
|
|
// Describes fields to update a webhook
|
|
export interface WebhookUpdate {
|
|
id: string;
|
|
fields: WebhookPatch;
|
|
}
|
|
|
|
// WebhookPatch should be `Partial<WebhookFields>` but generics are not yet supported by
|
|
// ts-interface-builder
|
|
export interface WebhookPatch {
|
|
url?: string;
|
|
eventTypes?: Array<"add"|"update">;
|
|
tableId?: string;
|
|
enabled?: boolean;
|
|
isReadyColumn?: string|null;
|
|
name?: string;
|
|
memo?: string;
|
|
}
|
|
|
|
|
|
export interface WebhookUsage {
|
|
// As minimum we need number of waiting events and status (by default pending).
|
|
numWaiting: number,
|
|
status: WebhookStatus;
|
|
updatedTime?: number|null;
|
|
lastSuccessTime?: number|null;
|
|
lastFailureTime?: number|null;
|
|
lastErrorMessage?: string|null;
|
|
lastHttpStatus?: number|null;
|
|
lastEventBatch?: null | {
|
|
size: number;
|
|
errorMessage: string|null;
|
|
httpStatus: number|null;
|
|
status: WebhookBatchStatus;
|
|
attempts: number;
|
|
},
|
|
numSuccess?: {
|
|
pastHour: number;
|
|
past24Hours: number;
|
|
},
|
|
}
|