> ## Documentation Index
> Fetch the complete documentation index at: https://docs.keephq.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Squadcast Provider

> Squadcast provider is a provider used for creating issues in Squadcast

## Authentication

This provider requires authentication.

* **service\_region**: Service region: EU/US (required: True, sensitive: False)
* **refresh\_token**: Squadcast Refresh Token (required: False, sensitive: True)
* **webhook\_url**: Incident webhook url (required: False, sensitive: True)

Certain scopes may be required to perform specific actions or queries via the provider. Below is a summary of relevant scopes and their use cases:

* **authenticated**: The user can connect to the client

## In workflows

This provider can be used in workflows.

As "action" to make changes or update data, example:

```yaml theme={null}
actions:
    - name: Query squadcast
      provider: squadcast
      config: "{{ provider.my_provider_name }}"
      with:
        notify_type: {value}  
        message: {value}  
        description: {value}  
        incident_id: {value}  
        priority: {value}  
        tags: {value}  
        status: {value}  
        event_id: {value}  
        attachments: {value}  
        additional_json: {value}  
```

Check the following workflow example:

* [squadcast\_example.yml](https://github.com/keephq/keep/blob/main/examples/workflows/squadcast_example.yml)

## Inputs

The `notify` function take following parameters as inputs:

* `notify_type` (required): Takes either of `incident` or `notes` depending on weather you want to create an incident or a note.

1. ##### parameters for `incident`
   * `message` (required): This will be the incident message.
   * `description` (required): This will be the incident description.
   * `tags` (optional): Tags for the incident. It should be a dict format.
   * `priority` (optional): Priority of the incident.
   * `status` (optional): Status of the event.
   * `event_id` (optional): event\_id is used to resolve an incident
   * `additional_json` (optional): Additional JSON data to be sent with the incident.
2. ##### parameters for `notes`
   * `message` (required): The message of the note.
   * `incident_id` (required): Id of the incident where the Note has to be created.
   * `attachments` (optional): List of attachments for the notes.

See [documentation](https://support.squadcast.com/integrations/incident-webhook-incident-webhook-api) for more

## Connecting with the Provider

1. Go to [Refresh Tokens](https://support.squadcast.com/terraform-and-api-documentation/public-api-refresh-token#from-your-profile-page) to see how to create a `refresh_token`.
2. Visit [Documentations](https://support.squadcast.com/integrations/incident-webhook-incident-webhook-api) to learn how to setup `incident_webhooks` & get the `webhook_url`

## Useful Links

* [Squadcast Incident API](https://support.squadcast.com/integrations/incident-webhook-incident-webhook-api)
* [Squadcast Refresh Tokens](https://support.squadcast.com/terraform-and-api-documentation/public-api-refresh-token#from-your-profile-page)
* [Incident Notes](https://support.squadcast.com/incidents-page/incident-notes)