Skip to content

Commit

Permalink
Add new configuration document for connection freshdesk (#102)
Browse files Browse the repository at this point in the history
  • Loading branch information
omerosaienni authored Sep 10, 2024
1 parent 9730037 commit cbfac25
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions docs/reference/config-files/connection/freshdesk.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: freshdesk
sidebar_label: freshdesk
---

# freshdesk

The `freshdesk` connection can be used to access Freshdesk resources.

```hcl
connection "freshdesk" "freshdesk_connection" {
api_key = "sk-jwgthNa..."
subdomain = "domain_name"
}
```

## Arguments

| Name | Type | Required?| Description
|-----------------|---------|----------|-------------------
| `api_key` | String | Optional | Freshdesk API key
| `subdomain` | String | Optional | Freshdesk subdomain

All arguments are optional, and a `freshdesk` connection with no arguments will behave the same as the [default connection](#default-connection).

## Default Connection

The `freshdesk` connection type includes an implicit, default connection (`connection.freshdesk.default`) that will be configured using the environment variables `FRESHDESK_API_KEY` and `FRESHDESK_SUBDOMAIN`.

```hcl
connection "freshdesk" "default" {
api_key = env("FRESHDESK_API_KEY")
subdomain = env("FRESHDESK_SUBDOMAIN")
}
```

0 comments on commit cbfac25

Please sign in to comment.