Integrations

Read the third-party integrations connected to your workspace through the WebPixie GraphQL API.

Some features and limits mentioned on this page vary by plan. Visit our Pricing page to review the plans.

Integrations connect your workspace to third-party tools that receive WebPixie notifications, such as Slack. Use getIntegrations to check which integrations are connected, whether they are working, and where they send messages. If your plan doesn't include integrations, the query returns an error.

`getIntegrations`

Paginated, filterable list of your workspace's integrations.

query {
  getIntegrations(query: "status = ACTIVE", limit: 25) {
    pagination {
      count
    }
    items {
      ... on IntegrationBase {
        id
        status
        integrationChannel
      }
      ... on Integration {
        lastUsedTime
        integrationDetail {
          ... on SlackIntegration {
            workspaceName
            target {
              name
            }
          }
        }
      }
    }
  }
}

Parameters

Name	Type	Description
`query`	`String`	Filter expression — see Discovering Filterable Fields.
`page`	`Int`	Page number, defaults to 1.
`limit`	`Int`	Page size, defaults to 10, capped at 100.
`sort`	`[Sort!]`	Sort order, defaults to newest first.

Response: an IntegrationList — pagination + items: [IntegrationListItem!]!. Each item is either an Integration, or an IncompleteIntegration while the connection is still waiting for authorization (status is PENDING_AUTH). Select the shared fields with ... on IntegrationBase.

Field	Type	Description
`id`	`ID!`	Unique identifier for the integration.
`user`	`WorkspaceUserDetail`	The workspace user who added the integration — `{ id, email, name }`.
`status`	`IntegrationStatus!`	`ACTIVE`, `PAUSED` (no notifications are sent through it), or `PENDING_AUTH` (waiting for the connection to be authorized).
`integrationChannel`	`IntegrationChannel!`	The tool the integration connects to. Currently `SLACK`.
`integrationApp`	`IntegrationApp!`	What the integration is used for. Currently `MESSAGING`.
`lastUsedTime`	`String`	ISO 8601 timestamp when the integration was last used. `Integration` only.
`connectTime`	`String`	ISO 8601 timestamp when the connection was authorized. `Integration` only.
`integrationDetail`	`IntegrationDetail!`	Connection details for the channel — see below. `Integration` only.
`createTime` / `updateTime`	`String!` / `String`	ISO 8601 timestamps for creation / last update.

SlackIntegration

integrationDetail for a Slack integration:

Field	Type	Description
`workspaceName`	`String`	Name of the connected Slack workspace.
`target`	`SlackTarget`	The Slack channel messages are posted to — `{ id, name }`.

getIntegrations

On this page

`getIntegrations`