Skip to main content
Version: 2026.09

System webhooks

Register an HTTPS or pipeline target that the platform calls when a System event happens. Methods are on the Client. The Python names are the generated operation ids.

Event values (SystemWebhookEvent):

  • system.snapshot.created
  • system.change_request.opened

Target values (WebhookTargetType): http, github_actions, gitlab_pipeline.

signing_secret is present on the create response only. Later reads return credential_masked (the last four characters).

create_webhook_api_v2_systems_system_id_webhooks_post()​

Creates a webhook on a System.

  • Parameters:

    • system_id (str) – (required)
    • new_system_webhook (NewSystemWebhook) – (required). name, target_type, target_config, and event_types are required. credential is optional.
    • http_request_timeout_secs (int, optional)

  • Return Type: SystemWebhook

list_webhooks_api_v2_systems_system_id_webhooks_get()​

Lists webhooks on a System.

  • Parameters:

    • system_id (str) – (required)
    • page (int, optional)
    • size (int, optional) – 1–100. Default 10.
    • http_request_timeout_secs (int, optional)

  • Return Type: PageSystemWebhook

get_webhook_api_v2_systems_system_id_webhooks_webhook_id_get()​

Returns one webhook.

  • Parameters:

    • system_id (str) – (required)
    • webhook_id (str) – (required)
    • http_request_timeout_secs (int, optional)

  • Return Type: SystemWebhook

update_webhook_api_v2_systems_system_id_webhooks_webhook_id_patch()​

Patches a webhook. Every field on UpdateSystemWebhook is optional: name, target_config, event_types, credential, enabled. The model distinguishes an omitted field from an explicit null, so you can clear credential by sending null.

  • Parameters:

    • system_id (str) – (required)
    • webhook_id (str) – (required)
    • update_system_webhook (UpdateSystemWebhook) – (required)
    • http_request_timeout_secs (int, optional)

  • Return Type: SystemWebhook

delete_webhook_api_v2_systems_system_id_webhooks_webhook_id_delete()​

Deletes a webhook.

  • Parameters:

    • system_id (str) – (required)
    • webhook_id (str) – (required)
    • http_request_timeout_secs (int, optional)

  • Return Type: None

list_webhook_deliveries_api_v2_systems_system_id_webhooks_webhook_id_deliveries_get()​

Lists delivery attempts for one webhook.

  • Parameters:

    • system_id (str) – (required)
    • webhook_id (str) – (required)
    • http_request_timeout_secs (int, optional)

  • Return Type: list of SystemWebhookDelivery