InboundIntegrationResource

Create an inbound integration

Creates a new inbound integration for a team. Set Type to one of the values returned by GET api/public/v1/inbound-integration/types.

Required API key permissions

  • Scope: inbound-integrations:create
  • Accepted key types: organization API key (org-wide), organization API key (team-scoped), personal access token (org-wide), personal access token (team-scoped)
  • Access: Access is checked against the specific resource (team or organization reachability).
  • Required team role (user-linked keys only): Administrator
  • Organization API keys are not subject to organization or team role checks.
post/api/public/v1/inbound-integration

Request

Query parameters

provisionboolean

When true, the created or updated resource is marked as provisioned and becomes read-only in the web UI. Defaults to false on create. On update, omitting this parameter preserves the existing provisioned state. Not available for personal access tokens.

Request body

displayNamestring required
teamIdstring uuid required
typestring required
isMutedboolean
isInMaintenanceboolean
noiseLimitInSecondsinteger nullable
labelsstring[] nullable

Response

OK

idstring uuid
isProvisionedboolean
displayNamestring nullable
typestring nullable
teamIdstring uuid
labelsstring[] nullable
isMutedboolean
isInMaintenanceboolean
webhookUrlstring nullable
noiseLimitInSecondsinteger nullable
isRedactedboolean

Changes

No recorded changes to this operation across all 1 revision of this API.