API ReferenceProjects

Get webhook URL and secret

Retrieves the webhook URL and secret for the current project. Webhooks come in two types: “trigger” webhooks are used for integration trigger events, while “event” webhooks receive system notifications about project events. The response includes both the URL and the secret key used to verify webhook signatures.

Headers

x-api-keystringRequired

Query parameters

typeenumRequired

Type of webhook to retrieve (trigger or event)

Allowed values:

Response

Webhook URL and secret retrieved successfully. Use the URL to receive events and the secret to verify incoming webhook signatures.
urlobject
The webhook configuration containing either trigger or event webhook URL
webhook_secretstring
The secret key that should be used to verify webhook signatures
statusenum
Indicates whether the webhook was found and retrieved successfully
Allowed values:

Errors