Skip to main content

AppWebhook

type AppWebhook = {
  callbackUrl: string;
  events: (
     | "project:added"
     | "project:updated"
     | "project:deleted"
     | "project:archived"
     | "project:unarchived"
     | "item:added"
     | "item:updated"
     | "item:completed"
     | "item:uncompleted"
     | "item:deleted"
     | "note:added"
     | "note:updated"
     | "note:deleted"
     | "section:added"
     | "section:updated"
     | "section:deleted"
     | "section:archived"
     | "section:unarchived"
     | "label:added"
     | "label:updated"
     | "label:deleted"
     | "filter:added"
     | "filter:updated"
     | "filter:deleted"
    | "reminder:fired")[];
  status: "active" | "invalid";
  version: "1";
};

Webhook configuration for a developer application.

Type Declaration​

NameTypeDefault value
callbackUrlstring-
events( | "project:added" | "project:updated" | "project:deleted" | "project:archived" | "project:unarchived" | "item:added" | "item:updated" | "item:completed" | "item:uncompleted" | "item:deleted" | "note:added" | "note:updated" | "note:deleted" | "section:added" | "section:updated" | "section:deleted" | "section:archived" | "section:unarchived" | "label:added" | "label:updated" | "label:deleted" | "filter:added" | "filter:updated" | "filter:deleted" | "reminder:fired")[]-
status"active" | "invalid"WebhookStatusSchema
version"1"WebhookVersionSchema