1. Registry
  2. Packages
  3. Descope Provider
  4. API Docs
  5. EightByEightWhatsappConnector
Viewing docs for Descope v1.0.1
published on Sunday, Oct 11, 2026 by Descope
descope logo Descope
Viewing docs for Descope v1.0.1
published on Sunday, Oct 11, 2026 by Descope

    Manages a 8x8 for WhatsApp connector and its configuration in a Descope project. Use the connector to send WhatsApp messages to the user.

    Create EightByEightWhatsappConnector Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new EightByEightWhatsappConnector(name: string, args: EightByEightWhatsappConnectorArgs, opts?: CustomResourceOptions);
    @overload
    def EightByEightWhatsappConnector(resource_name: str,
                                      args: EightByEightWhatsappConnectorArgs,
                                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def EightByEightWhatsappConnector(resource_name: str,
                                      opts: Optional[ResourceOptions] = None,
                                      api_key: Optional[str] = None,
                                      project_id: Optional[str] = None,
                                      sub_account_id: Optional[str] = None,
                                      template_id: Optional[str] = None,
                                      country: Optional[str] = None,
                                      description: Optional[str] = None,
                                      disabled: Optional[bool] = None,
                                      name: Optional[str] = None,
                                      use_static_ips: Optional[bool] = None)
    func NewEightByEightWhatsappConnector(ctx *Context, name string, args EightByEightWhatsappConnectorArgs, opts ...ResourceOption) (*EightByEightWhatsappConnector, error)
    public EightByEightWhatsappConnector(string name, EightByEightWhatsappConnectorArgs args, CustomResourceOptions? opts = null)
    public EightByEightWhatsappConnector(String name, EightByEightWhatsappConnectorArgs args)
    public EightByEightWhatsappConnector(String name, EightByEightWhatsappConnectorArgs args, CustomResourceOptions options)
    
    type: descope:EightByEightWhatsappConnector
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "descope_eight_by_eight_whatsapp_connector" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args EightByEightWhatsappConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args EightByEightWhatsappConnectorArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args EightByEightWhatsappConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EightByEightWhatsappConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EightByEightWhatsappConnectorArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var eightByEightWhatsappConnectorResource = new Descope.EightByEightWhatsappConnector("eightByEightWhatsappConnectorResource", new()
    {
        ApiKey = "string",
        ProjectId = "string",
        SubAccountId = "string",
        TemplateId = "string",
        Country = "string",
        Description = "string",
        Disabled = false,
        Name = "string",
        UseStaticIps = false,
    });
    
    example, err := descope.NewEightByEightWhatsappConnector(ctx, "eightByEightWhatsappConnectorResource", &descope.EightByEightWhatsappConnectorArgs{
    	ApiKey:       pulumi.String("string"),
    	ProjectId:    pulumi.String("string"),
    	SubAccountId: pulumi.String("string"),
    	TemplateId:   pulumi.String("string"),
    	Country:      pulumi.String("string"),
    	Description:  pulumi.String("string"),
    	Disabled:     pulumi.Bool(false),
    	Name:         pulumi.String("string"),
    	UseStaticIps: pulumi.Bool(false),
    })
    
    resource "descope_eight_by_eight_whatsapp_connector" "eightByEightWhatsappConnectorResource" {
      lifecycle {
        create_before_destroy = true
      }
      api_key        = "string"
      project_id     = "string"
      sub_account_id = "string"
      template_id    = "string"
      country        = "string"
      description    = "string"
      disabled       = false
      name           = "string"
      use_static_ips = false
    }
    
    var eightByEightWhatsappConnectorResource = new EightByEightWhatsappConnector("eightByEightWhatsappConnectorResource", EightByEightWhatsappConnectorArgs.builder()
        .apiKey("string")
        .projectId("string")
        .subAccountId("string")
        .templateId("string")
        .country("string")
        .description("string")
        .disabled(false)
        .name("string")
        .useStaticIps(false)
        .build());
    
    eight_by_eight_whatsapp_connector_resource = descope.EightByEightWhatsappConnector("eightByEightWhatsappConnectorResource",
        api_key="string",
        project_id="string",
        sub_account_id="string",
        template_id="string",
        country="string",
        description="string",
        disabled=False,
        name="string",
        use_static_ips=False)
    
    const eightByEightWhatsappConnectorResource = new descope.EightByEightWhatsappConnector("eightByEightWhatsappConnectorResource", {
        apiKey: "string",
        projectId: "string",
        subAccountId: "string",
        templateId: "string",
        country: "string",
        description: "string",
        disabled: false,
        name: "string",
        useStaticIps: false,
    });
    
    type: descope:EightByEightWhatsappConnector
    properties:
        apiKey: string
        country: string
        description: string
        disabled: false
        name: string
        projectId: string
        subAccountId: string
        templateId: string
        useStaticIps: false
    

    EightByEightWhatsappConnector Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The EightByEightWhatsappConnector resource accepts the following input properties:

    ApiKey string
    The 8x8 API key for authentication.
    ProjectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    SubAccountId string
    The 8x8 sub-account ID is required for the Messaging API.
    TemplateId string
    The ID of a WhatsApp message template.
    Country string
    The country code or region where your Viber messaging service is configured.
    Description string
    A description of what your connector is used for.
    Disabled bool
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    Name string
    A custom name for your connector.
    UseStaticIps bool
    Whether the connector should send all requests from specific static IPs.
    ApiKey string
    The 8x8 API key for authentication.
    ProjectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    SubAccountId string
    The 8x8 sub-account ID is required for the Messaging API.
    TemplateId string
    The ID of a WhatsApp message template.
    Country string
    The country code or region where your Viber messaging service is configured.
    Description string
    A description of what your connector is used for.
    Disabled bool
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    Name string
    A custom name for your connector.
    UseStaticIps bool
    Whether the connector should send all requests from specific static IPs.
    api_key string
    The 8x8 API key for authentication.
    project_id string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    sub_account_id string
    The 8x8 sub-account ID is required for the Messaging API.
    template_id string
    The ID of a WhatsApp message template.
    country string
    The country code or region where your Viber messaging service is configured.
    description string
    A description of what your connector is used for.
    disabled bool
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    name string
    A custom name for your connector.
    use_static_ips bool
    Whether the connector should send all requests from specific static IPs.
    apiKey String
    The 8x8 API key for authentication.
    projectId String
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    subAccountId String
    The 8x8 sub-account ID is required for the Messaging API.
    templateId String
    The ID of a WhatsApp message template.
    country String
    The country code or region where your Viber messaging service is configured.
    description String
    A description of what your connector is used for.
    disabled Boolean
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    name String
    A custom name for your connector.
    useStaticIps Boolean
    Whether the connector should send all requests from specific static IPs.
    apiKey string
    The 8x8 API key for authentication.
    projectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    subAccountId string
    The 8x8 sub-account ID is required for the Messaging API.
    templateId string
    The ID of a WhatsApp message template.
    country string
    The country code or region where your Viber messaging service is configured.
    description string
    A description of what your connector is used for.
    disabled boolean
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    name string
    A custom name for your connector.
    useStaticIps boolean
    Whether the connector should send all requests from specific static IPs.
    api_key str
    The 8x8 API key for authentication.
    project_id str
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    sub_account_id str
    The 8x8 sub-account ID is required for the Messaging API.
    template_id str
    The ID of a WhatsApp message template.
    country str
    The country code or region where your Viber messaging service is configured.
    description str
    A description of what your connector is used for.
    disabled bool
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    name str
    A custom name for your connector.
    use_static_ips bool
    Whether the connector should send all requests from specific static IPs.
    apiKey String
    The 8x8 API key for authentication.
    projectId String
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    subAccountId String
    The 8x8 sub-account ID is required for the Messaging API.
    templateId String
    The ID of a WhatsApp message template.
    country String
    The country code or region where your Viber messaging service is configured.
    description String
    A description of what your connector is used for.
    disabled Boolean
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    name String
    A custom name for your connector.
    useStaticIps Boolean
    Whether the connector should send all requests from specific static IPs.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the EightByEightWhatsappConnector resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing EightByEightWhatsappConnector Resource

    Get an existing EightByEightWhatsappConnector resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: EightByEightWhatsappConnectorState, opts?: CustomResourceOptions): EightByEightWhatsappConnector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            api_key: Optional[str] = None,
            country: Optional[str] = None,
            description: Optional[str] = None,
            disabled: Optional[bool] = None,
            name: Optional[str] = None,
            project_id: Optional[str] = None,
            sub_account_id: Optional[str] = None,
            template_id: Optional[str] = None,
            use_static_ips: Optional[bool] = None) -> EightByEightWhatsappConnector
    func GetEightByEightWhatsappConnector(ctx *Context, name string, id IDInput, state *EightByEightWhatsappConnectorState, opts ...ResourceOption) (*EightByEightWhatsappConnector, error)
    public static EightByEightWhatsappConnector Get(string name, Input<string> id, EightByEightWhatsappConnectorState? state, CustomResourceOptions? opts = null)
    public static EightByEightWhatsappConnector get(String name, Output<String> id, EightByEightWhatsappConnectorState state, CustomResourceOptions options)
    resources:  existingEightByEightWhatsappConnector:    type: descope:EightByEightWhatsappConnector    get:      id: ${id}
    import {
      to = descope_eight_by_eight_whatsapp_connector.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    state EightByEightWhatsappConnectorState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state EightByEightWhatsappConnectorState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    state EightByEightWhatsappConnectorState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    state EightByEightWhatsappConnectorState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    options CustomResourceOptions
    Bag of options to control resource's behavior.
    The following state arguments are supported:
    ApiKey string
    The 8x8 API key for authentication.
    Country string
    The country code or region where your Viber messaging service is configured.
    Description string
    A description of what your connector is used for.
    Disabled bool
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    Name string
    A custom name for your connector.
    ProjectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    SubAccountId string
    The 8x8 sub-account ID is required for the Messaging API.
    TemplateId string
    The ID of a WhatsApp message template.
    UseStaticIps bool
    Whether the connector should send all requests from specific static IPs.
    ApiKey string
    The 8x8 API key for authentication.
    Country string
    The country code or region where your Viber messaging service is configured.
    Description string
    A description of what your connector is used for.
    Disabled bool
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    Name string
    A custom name for your connector.
    ProjectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    SubAccountId string
    The 8x8 sub-account ID is required for the Messaging API.
    TemplateId string
    The ID of a WhatsApp message template.
    UseStaticIps bool
    Whether the connector should send all requests from specific static IPs.
    api_key string
    The 8x8 API key for authentication.
    country string
    The country code or region where your Viber messaging service is configured.
    description string
    A description of what your connector is used for.
    disabled bool
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    name string
    A custom name for your connector.
    project_id string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    sub_account_id string
    The 8x8 sub-account ID is required for the Messaging API.
    template_id string
    The ID of a WhatsApp message template.
    use_static_ips bool
    Whether the connector should send all requests from specific static IPs.
    apiKey String
    The 8x8 API key for authentication.
    country String
    The country code or region where your Viber messaging service is configured.
    description String
    A description of what your connector is used for.
    disabled Boolean
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    name String
    A custom name for your connector.
    projectId String
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    subAccountId String
    The 8x8 sub-account ID is required for the Messaging API.
    templateId String
    The ID of a WhatsApp message template.
    useStaticIps Boolean
    Whether the connector should send all requests from specific static IPs.
    apiKey string
    The 8x8 API key for authentication.
    country string
    The country code or region where your Viber messaging service is configured.
    description string
    A description of what your connector is used for.
    disabled boolean
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    name string
    A custom name for your connector.
    projectId string
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    subAccountId string
    The 8x8 sub-account ID is required for the Messaging API.
    templateId string
    The ID of a WhatsApp message template.
    useStaticIps boolean
    Whether the connector should send all requests from specific static IPs.
    api_key str
    The 8x8 API key for authentication.
    country str
    The country code or region where your Viber messaging service is configured.
    description str
    A description of what your connector is used for.
    disabled bool
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    name str
    A custom name for your connector.
    project_id str
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    sub_account_id str
    The 8x8 sub-account ID is required for the Messaging API.
    template_id str
    The ID of a WhatsApp message template.
    use_static_ips bool
    Whether the connector should send all requests from specific static IPs.
    apiKey String
    The 8x8 API key for authentication.
    country String
    The country code or region where your Viber messaging service is configured.
    description String
    A description of what your connector is used for.
    disabled Boolean
    Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
    name String
    A custom name for your connector.
    projectId String
    The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
    subAccountId String
    The 8x8 sub-account ID is required for the Messaging API.
    templateId String
    The ID of a WhatsApp message template.
    useStaticIps Boolean
    Whether the connector should send all requests from specific static IPs.

    Package Details

    Repository
    descope descope/pulumi-descope
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the descope Terraform Provider.
    descope logo Descope
    Viewing docs for Descope v1.0.1
    published on Sunday, Oct 11, 2026 by Descope

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial