Send a provider fixture through a surface’s real ingress

Resolve an authorized surface by its globally unique ID and send a provider-native fixture through the same authenticated ingress used by production deliveries.

Authentication

AuthorizationBearer

API key or Clerk session token

Path parameters

surfaceIdstringRequired

Request

This endpoint expects an object.

fixtureenumRequired

Allowed values:

pullRequestintegerRequired

repositorystringRequiredformat: "^[^/\s]+\/[^/\s]+$"

deliveryIdstringOptionalformat: "^[A-Za-z0-9._:-]{1,128}$"

Reuse a previous delivery ID (X-GitHub-Delivery), so the ingress can show it handles a repeat once.

payloadmap from strings to anyOptional

Send and sign this payload instead of the fixture built from the pull request (an edited fixture).

planningPathstringOptional>=1 character

repeatintegerOptional1-3

Response

Provider delivery attempts accepted by the surface ingress.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

502

Bad Gateway Error