Mail API reference

Mail API · Integrations

get/v1/workspaces/{workspace_id}/integrations/github/appAuth

Whether the ProductCraft Mail GitHub App is available, and what it asks for.

Path parameters

workspace_id*string · uuid

Id of the workspace.

Response · 200

available*boolean

True once the ProductCraft Mail GitHub App is set up; until then only the older OAuth Connect exists.

slug*string

The App's slug on GitHub; null until it is set up.

Example: "productcraft-mail"

html_url*string · uri

The App's public page on GitHub; null until it is set up.

permissions*object

Repository permissions the App asks for when installed.

Example: {"contents":"read","metadata":"read","pull_requests":"read","checks":"write"}

events*array

Webhook events the App receives.

Example: ["push","pull_request"]

Example

Request

GET https://api.mail.productcraft.co/v1/workspaces/{workspace_id}/integrations/github/app
Authorization: Bearer YOUR_TOKEN

Response

{
  "available": false,
  "slug": "productcraft-mail",
  "html_url": "string",
  "permissions": {
    "contents": "read",
    "metadata": "read",
    "pull_requests": "read",
    "checks": "write"
  },
  "events": [
    "push",
    "pull_request"
  ]
}