Shipeasy
Flags experimentsApiOperations

Test a connector

Dispatches a single synthetic bug.created payload to the connector's destination so you can verify the integration end-to-end. Unlike fire, this runs the…

Dispatches a single synthetic bug.created payload to the connector's destination so you can verify the integration end-to-end. Unlike fire, this runs the real dispatch path (posts a Slack message / appends a Sheets row / files a GitHub Issue) with throwaway test content. The attempt's outcome is recorded on the connector's lastAttemptAt / lastError / lastSuccessAt.

When the provider produces a linkable artifact (e.g. a GitHub Issue), its URL is returned as issueUrl; otherwise issueUrl is null.

Use case

Click "Send test" after wiring up a connector to confirm credentials and config are correct before relying on it for real events.

POST
/api/admin/connectors/{id}/test

Authorization

bearerSdkKey
AuthorizationBearer <token>

Pass an admin SDK key as Authorization: Bearer sdk_admin_…. Mint via POST /api/admin/keys with type: "admin".

In: header

Path Parameters

id*string

Stable opaque connector id.

Length1 <= length <= 128

Header Parameters

X-Project-Id?string

Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://shipeasy.ai/api/admin/connectors/string/test"
{
  "ok": true,
  "issueUrl": "https://github.com/acme/app/issues/4217"
}
{
  "error": "Malformed request (bad JSON, missing project scope).",
  "code": "BAD_REQUEST"
}
{
  "error": "Missing or invalid admin SDK key.",
  "code": "UNAUTHORIZED"
}

{
  "error": "Key is valid but not allowed to act on this project.",
  "code": "FORBIDDEN"
}

{
  "error": "The resource does not exist or is not visible to the caller.",
  "code": "NOT_FOUND"
}

{
  "error": "A resource with this name already exists in the project.",
  "code": "ALREADY_EXISTS"
}

{
  "error": "The request body failed structural (schema) validation.",
  "code": "VALIDATION"
}

{
  "error": "GitHub API responded 403: resource not accessible by integration."
}
Was this page helpful?
✎ Edit this page