Post a test message to verify delivery

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

Requires project.channels.write.

Arguments

ArgumentTypeRequiredDescription
projectReferenceID!YesProject ID or slug. Requires a person's credential; agent, run, and service-account callers are forbidden.
channelIdID!Yes
inputCheckChannelInput!Yes

Input fields

input

CheckChannelInput

FieldTypeRequiredDescription
slackChannelIdString!YesSlack 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.
textStringNo1-4000 characters; default 'Veryfront Slack connection test'.

Response

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

FieldTypeDescription
channelIdID!
slackChannelIdString!
statusChannelCheckStatus!
messageIdStringSlack message timestamp of the delivered message.
failureCodeChannelCheckFailureCode
retryableBoolean!
checkedAtDateTime!

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

Example

graphql
mutation CheckChannel($projectReference: ID!, $channelId: ID!, $input: CheckChannelInput!) {
  checkChannel(projectReference: $projectReference, channelId: $channelId, input: $input) {
    status
    channelId
    checkedAt
    failureCode
    messageId
  }
}
json
{
  "projectReference": "00000000-0000-4000-8000-000000000001",
  "channelId": "00000000-0000-4000-8000-000000000001",
  "input": {
    "slackChannelId": "00000000-0000-4000-8000-000000000001"
  }
}