git.webhooks.create

Add a webhook

POST /git/api/repositories/{repoId}/webhooksIAM git:CreateWebhookChanges state

Request syntax

POST /git/api/repositories/{repoId}/webhooks
{
  "url": "string",
  "events": "enum",
  "secret": "string",
  "isActive": "boolean"
}

Path parameters

  • repoIdRequired

    string

    Constraints: uuid

Request body

  • urlRequired

    string

    The public URL each delivery is POSTed to

    Constraints: url

  • eventsRequired

    enum

    The events that trigger a delivery

    One of: push, tag, pull_request, pull_request_review, issues, issue_comment, release, merge_queue

  • secretOptional

    string

    Signs each delivery with an HMAC-SHA256 of its body (`sha256=…` header); unsigned when absent

    Constraints: max 200 chars

  • isActiveOptional

    boolean

    false pauses deliveries without deleting the hook; true when created without it

Response

201 with the hook, as `list` shows it.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Fields of data

  • idAlways

    string

    The webhook id
  • orgIdAlways

    string

    The organization it belongs to
  • repoIdAlways

    string

    The repository whose events it receives
  • urlAlways

    string

    The URL each delivery is POSTed to
  • eventsAlways

    string

    The events it subscribes to, as a JSON array in text, e.g. ["push","pull_request"]
  • isActiveAlways

    boolean

    Whether events are delivered; an inactive hook receives none
  • createdAtAlways

    string

    When it was created (ISO 8601)
  • updatedAtAlways

    string

    When it last changed (ISO 8601)
  • hasSecretAlways

    boolean

    Whether deliveries are signed with a secret; the secret itself is never returned

Checked against the handlers: every route test validates their answers against this schema.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow git:CreateWebhook on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud git webhooks create repoId --url example --events push

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_git_webhooks_create.