Mutation

mutation SendTestBroadcast($input: SendTestBroadcastInput!) {
  sendTestBroadcast(input: $input) {
    broadcast {
      id
      name
      notificationTitle
      content
      contentFormat
      type
    }
    error {
      message
      type
      code
      fields {
        field
        message
        type
      }
    }
  }
}

Variables

{
  "input": {
    "broadcastId": "id",
    "channels": [
      {
        "slackTeamId": "id",
        "slackChannelId": "id"
      }
    ]
  }
}

Response

{
  "data": {
    "sendTestBroadcast": {
      "broadcast": {
        "id": "id",
        "name": "string",
        "notificationTitle": "string",
        "content": "string",
        "contentFormat": "TIPTAP",
        "type": "SLACK"
      },
      "error": {
        "message": "string",
        "type": "VALIDATION",
        "code": "string",
        "fields": [
          {
            "field": "string",
            "message": "string",
            "type": "VALIDATION"
          }
        ]
      }
    }
  }
}

Mutations

sendTestBroadcast

Sends the broadcast to the Slack channels you name, up to 10, so you can see what recipients will get before the real audience does. It goes out through the same pipeline as a real send, under the broadcast’s own sender, so what arrives is what any channel would have received — with a notice at the top marking it as a test, since everyone in the channels you choose will see it.

Every channel must already be connected to this workspace. They are independent of the broadcast’s own audience, which is left untouched: the broadcast needs a sender and a notification title, but it does not need any channels of its own, because testing is what you do before choosing them.

Only available while the broadcast can still be edited: once its send has started, it can no longer be tested.

A test send never changes the broadcast’s status, and never unlocks or locks editing. Requires the broadcast:send permission.

MUTATION

sendTestBroadcast(input: SendTestBroadcastInput!): SendTestBroadcastOutput!

Arguments

input

SendTestBroadcastInput!

required

Returns

SendTestBroadcastOutput!

broadcast

Broadcast

error

MutationError