Function: updateWebhook()
updateWebhook(
client,props):Promise<{id:number;url:string;events: ("asset.created"|"asset.deleted"|"asset.liked"|"asset.moderated"|"asset.updated"|"comment.liked"|"comment.moderated"|"comment.new"|"comment.updated"|"external-auth.approved"|"member.added"|"member.removed"|"notification.new"|"org.created"|"org.deleted"|"org.invite"|"org.updated"|"product.created"|"product.deleted"|"product.updated"|"project.created"|"project.deleted"|"project.invite"|"project.updated")[];secret?:string;description:string|null;active:boolean;scope:"project"|"org";orgName:string;projectName?:string;createdAt:string;updatedAt:string; }>
Parameters
client
props
params
{ webhookId: number; } = webhookIdParamsSchema
params.webhookId
number = ...
body
{ url?: string; events?: ("asset.created" | "asset.deleted" | "asset.liked" | "asset.moderated" | "asset.updated" | "comment.liked" | "comment.moderated" | "comment.new" | "comment.updated" | "external-auth.approved" | "member.added" | "member.removed" | "notification.new" | "org.created" | "org.deleted" | "org.invite" | "org.updated" | "product.created" | "product.deleted" | "product.updated" | "project.created" | "project.deleted" | "project.invite" | "project.updated")[]; active?: boolean; description?: string; secret?: string; } = updateWebhookBodySchema
body.url?
string = ...
body.events?
("asset.created" | "asset.deleted" | "asset.liked" | "asset.moderated" | "asset.updated" | "comment.liked" | "comment.moderated" | "comment.new" | "comment.updated" | "external-auth.approved" | "member.added" | "member.removed" | "notification.new" | "org.created" | "org.deleted" | "org.invite" | "org.updated" | "product.created" | "product.deleted" | "product.updated" | "project.created" | "project.deleted" | "project.invite" | "project.updated")[] = ...
body.active?
boolean = ...
body.description?
string = ...
body.secret?
string = ...
Returns
Promise<{ id: number; url: string; events: ("asset.created" | "asset.deleted" | "asset.liked" | "asset.moderated" | "asset.updated" | "comment.liked" | "comment.moderated" | "comment.new" | "comment.updated" | "external-auth.approved" | "member.added" | "member.removed" | "notification.new" | "org.created" | "org.deleted" | "org.invite" | "org.updated" | "product.created" | "product.deleted" | "product.updated" | "project.created" | "project.deleted" | "project.invite" | "project.updated")[]; secret?: string; description: string | null; active: boolean; scope: "project" | "org"; orgName: string; projectName?: string; createdAt: string; updatedAt: string; }>