Skip to main content

WhatsAppConfigGql

The organization's WhatsApp setup. The API key is never returned in full.

type WhatsAppConfigGql {
  apiKeyLast4: String
  capabilities: WhatsAppProviderCapabilitiesGql!
  channelId: String
  channelName: String
  defaultCountryCode: String
  displayName: String!
  hasApiKey: Boolean!
  id: ID!
  isEnabled: Boolean!
  provider: String!
  triggers: [WhatsAppTriggerConfigGql!]!
  updatedAt: DateTime!
  verifiedAt: DateTime
}

Fields

`WhatsAppConfigGql.apiKeyLast4` ● `String` scalar

The last four characters of the API key.

`WhatsAppConfigGql.capabilities` ● `WhatsAppProviderCapabilitiesGql!` non-null object

What the provider supports.

`WhatsAppConfigGql.channelId` ● `String` scalar

The ID of the channel messages are sent on.

`WhatsAppConfigGql.channelName` ● `String` scalar

The name of that channel.

`WhatsAppConfigGql.defaultCountryCode` ● `String` scalar

The country code added to phone numbers that have none.

`WhatsAppConfigGql.displayName` ● `String!` non-null scalar

The name of the setup.

`WhatsAppConfigGql.hasApiKey` ● `Boolean!` non-null scalar

True when an API key is stored.

`WhatsAppConfigGql.id` ● `ID!` non-null scalar

The unique ID of this record.

`WhatsAppConfigGql.isEnabled` ● `Boolean!` non-null scalar

True when WhatsApp sending is switched on.

`WhatsAppConfigGql.provider` ● `String!` non-null scalar

The provider.

`WhatsAppConfigGql.triggers` ● `[WhatsAppTriggerConfigGql!]!` non-null object

The setup of each trigger.

`WhatsAppConfigGql.updatedAt` ● `DateTime!` non-null scalar

When the record was last changed.

`WhatsAppConfigGql.verifiedAt` ● `DateTime` scalar

When the setup was last verified.

Returned By

setWhatsAppEnabled mutation ● testWhatsAppConnection mutation ● updateWhatsAppTrigger mutation ● upsertWhatsAppConfig mutation ● whatsAppConfig query

Fields
Returned By