webhook_shared: type: object properties: enabled: type: boolean description: Determine if the webhook is active. events: type: array description: > The events that will be published to the webhook. If the events parameter is omitted all the events will be subscribed. items: $ref: "#/webhook_event_type" environments: type: array description: > The environments from which the webhook will receive events. Allowed values are “sandbox” and “live”. If the environments parameter is omitted the webhook will receive events from both environments. items: type: string payload_version: type: integer description: Webhook version used to control the payload object when sending webhooks. oauth_enabled: type: boolean description: Determines if the webhook will fetch OAuth access tokens to send in the Authorization header. oauth_server_url: type: string description: The url to fetch the OAuth access token using client credentials grant. oauth_server_client_id: type: string description: The client id to authenticate the client credentials grant. oauth_server_client_secret: type: string description: The client secret to authenticate the client credentials grant. oauth_server_scope: type: string description: The scopes to be sent when requesting the access token. webhook_response: type: object required: - id properties: id: type: string format: uuid description: The unique identifier of the webhook. name: type: string description: Name of the webhook. url: $ref: "#/webhook_url" token: type: string description: Webhook secret token used to sign the webhook's payload. href: type: string description: The API endpoint to retrieve the webhook. webhook_create: required: - url properties: name: type: string description: Name of the webhook. url: $ref: "#/webhook_url" webhook_update: properties: name: type: string description: Name of the webhook. url: $ref: "#/webhook_url" webhook_event_resource_type: type: string enum: - check - report - audit_log - workflow_run - workflow_task - watchlist_monitor - workflow_timeline_file - workflow_run_evidence_folder webhook_event_type: type: string enum: - audit_log.created - watchlist_monitor.matches_updated - workflow_run.completed - workflow_task.started - workflow_task.completed - check.started - check.reopened - check.withdrawn - check.completed - check.form_completed - report.withdrawn - report.resumed - report.cancelled - report.awaiting_approval - report.completed - workflow_timeline_file.created - workflow_run_evidence_folder.created webhook_url: type: string description: The url that will listen to notifications (must be https).