Post a test message to verify delivery - Veryfront

checkChannel(projectReference: ID!, channelId: ID!, input: CheckChannelInput!): ChannelCheckResult!

Requires project.channels.write.

Arguments

Argument	Type	Required	Description
`projectReference`	`ID!`	Yes	Project ID or slug. Requires a person’s credential; agent, run, and service-account callers are forbidden.
`channelId`	`ID!`	Yes
`input`	`CheckChannelInput!`	Yes

Input fields

input

CheckChannelInput

Field	Type	Required	Description
`slackChannelId`	`String!`	Yes	Slack channel for the test message. Slack refusals return status failed with a failure code. A missing Slack connection returns validation-failed; a transient connection refresh failure returns external-service-error.
`text`	`String`	No	1-4000 characters; default ‘Veryfront Slack connection test’.

Response

Returns ChannelCheckResult!. Open the type for its fields and nested types.

Field	Type	Description
`channelId`	`ID!`
`slackChannelId`	`String!`
`status`	`ChannelCheckStatus!`
`messageId`	`String`	Slack message timestamp of the delivered message.
`failureCode`	`ChannelCheckFailureCode`
`retryable`	`Boolean!`
`checkedAt`	`DateTime!`

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

mutation CheckChannel($projectReference: ID!, $channelId: ID!, $input: CheckChannelInput!) {
  checkChannel(projectReference: $projectReference, channelId: $channelId, input: $input) {
    status
    channelId
    checkedAt
    failureCode
    messageId
  }
}

{
  "projectReference": "00000000-0000-4000-8000-000000000001",
  "channelId": "00000000-0000-4000-8000-000000000001",
  "input": {
    "slackChannelId": "00000000-0000-4000-8000-000000000001"
  }
}