Skip to content
Search
Search the documentation
CreateProjectWebhookResponse
GitHub GitHub

CreateProjectWebhookResponse

Interface: CreateProjectWebhookResponse

Defined in: v1/types/webhooks.ts:66

Response for creating a project webhook. secret is only returned here and on rotation - store it immediately, it cannot be retrieved again.

  • POST /v1/projects/:project_id/webhooks

See

https://docs.top.gg/api/v1/project-webhooks#post-projectsproject_idwebhooks

Extends

Properties

id

id: string

Defined in: v1/types/webhooks.ts:15

The webhook’s unique identifier.

Inherited from

ProjectWebhook.id


label

label: string

Defined in: v1/types/webhooks.ts:19

The dashboard label for this webhook.

Inherited from

ProjectWebhook.label


secret

secret: string

Defined in: v1/types/webhooks.ts:71

The signing secret used to verify the x-topgg-signature header on delivered webhook requests. Prefixed with whs_.


url

url: string

Defined in: v1/types/webhooks.ts:23

The HTTPS URL Top.gg delivers webhook events to.

Inherited from

ProjectWebhook.url