Function: createWebhook()

createWebhook(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

ApiClient

props

query

{ orgName: string; } | { orgName: string; projectName: string; } = webhookQueryScopeSchema

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")[]; secret?: string; description?: string; active: boolean; } = createWebhookBodySchema

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.secret?

string = ...

body.description?

string = ...

body.active

boolean = ...

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; }>