Skip to main content

WebhookResponseDto

Response representing a webhook configuration, including its environment and signing secret.

urlstringrequired

URL of the webhook

Example: https://foo.com/webhooks/bar
descriptionstringnullable

Description of the webhook

Example: Webhook for X production
idstring<uuid>required

UUID of the webhook

Example: 92f74e96-a654-47e2-84c8-7a8843cda443
apiEnvironmentAPIEnvironment (string)required

Possible values: [Sandbox, Production]

signingSecretKeystringrequired

Signature key secret

Example: 92f74e96a65447e284c87a8843cda443
WebhookResponseDto
{
"url": "https://foo.com/webhooks/bar",
"description": "Webhook for X production",
"id": "92f74e96-a654-47e2-84c8-7a8843cda443",
"apiEnvironment": "Sandbox",
"signingSecretKey": "92f74e96a65447e284c87a8843cda443"
}