Inspect

Report deployment

Report deployment status for one or more pull requests. Accepts normal personal or system API keys with write access and access to the repository workspace. Only deployed and failed statuses are accepted. Each new event is notified independently, without a cross-environment completion gate. Send requests to your own workspace origin. Idempotency keys are scoped per repository/PR, independent of the API key: retries with the same key do not record or notify again. Reuse a key only for the same event.

Base URL
POST
/api/public/v1/repositories/{owner}/{repo}/deployments

Report deployment status for one or more pull requests. Accepts normal personal or system API keys with write access and access to the repository workspace. Only deployed and failed statuses are accepted. Each new event is notified independently, without a cross-environment completion gate. Send requests to your own workspace origin. Idempotency keys are scoped per repository/PR, independent of the API key: retries with the same key do not record or notify again. Reuse a key only for the same event.

Authorization

bearerAuth
headerAuthorizationBearer <token>

API key authentication. Use your API key as the bearer token.

Path Parameters

owner*string

GitHub repository owner.

Match^[^/\s]+$
repo*string

GitHub repository name.

Match^[^/\s]+$

Header Parameters

Idempotency-Key*string

Stable event ID, deduplicated per repository/PR across retries and credential rotation. Trimmed before the length check.

Length1 <= length <= 200

Request Body

application/json
  1. body

Unknown properties are rejected. String values are trimmed before length limits are checked.

pull_request_numbers*array<>

Pull requests the deployment applies to. Values must be unique.

Items1 <= items <= 500
status*Deployments.DeploymentStatus
Value in"deployed""failed"
environment?string

Optional caller-defined environment, shown in notifications and never a completion gate. Omission uses the storage key default.

Length1 <= length <= 200
error?|

Optional deployment failure details.

Lengthlength <= 2000
occurred_at?string

When the deployment transition occurred. Defaults to receipt time.

Formatdate-time

Response Body

The event was recorded, or was already recorded with the same idempotency key. Slack delivery is asynchronous and best effort.

application/json
  1. response
data*
Example Request
curl -X POST 'https://your-org.inspect.com/api/public/v1/repositories/string/string/deployments' \  -H 'Idempotency-Key: string' \  -H 'Content-Type: application/json' \  -d '{  "pull_request_numbers": [    1  ],  "status": "deployed"}'
Example Response
{  "data": {    "repository": "string",    "pull_request_numbers": [      1    ]  }}