Skip to main content

Transmissions

The transmission API queries integration messages, creates contact-addressed outbound deliveries, exposes attachment download URLs, and can requeue delivery.

Create and deliver​

mutation SendToPartner($organizationId: Int!, $contactId: Int!, $payload: Any!) {
  createTransmission(
    organizationId: $organizationId
    values: {
      contactId: $contactId
      messageType: "order.created"
      payload: $payload
      payloadContentType: "application/json"
    }
  ) {
    transmissionId
    contactId
    channel
    direction
    status
    payloadRef
  }
}

direction defaults to Outbound. When the contact has a supported customValues.transmission configuration, creation queues delivery through the outbox and defaults an unspecified status to Pending. payload and payloadRef are mutually exclusive.

Query attachments​

query Transmission($organizationId: Int!, $transmissionId: Int!) {
  transmission(organizationId: $organizationId, transmissionId: $transmissionId) {
    transmissionId
    contactId
    status
    attachments {
      fileName
      contentType
      byteSize
      url
      metadata
    }
  }
}

The computed attachments field returns authorized, short-lived download URLs and does not expose private storage keys.

Redeliver​

mutation Redeliver($organizationId: Int!, $transmissionId: Int!) {
  redeliverTransmission(organizationId: $organizationId, transmissionId: $transmissionId) {
    transmissionId
    status
  }
}

Redelivery only accepts outbound transmissions whose contact has a supported transport. It clears the previous error, sets Pending, and requeues the idempotent delivery command.