> For the complete documentation index, see [llms.txt](https://docs.navigaglobal.com/push-notifications/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.navigaglobal.com/push-notifications/admin-guide/configuration.md).

# Configuration

The configuration of this plugin only has one required field. The rest of the config is if you have the content agent enabled.

**Required:**

* URL to backend services

The URL you need to configure is:

{% hint style="success" %}
<https://pushbackend.saas-\\{{ENV\\}}.navigacloud.com/twirp/pushbackend.PushServices>
{% endhint %}

Replace `{{ENV}}` with either `dev`, `stage` or `prod` depending on which environment the dashboard is running.

### Content Agent

#### Provider Key

If you have mapped the Content Agent plugin you will need to specify the name of the open content to use from the Content Agent. The default value is a variable from the Dashboard Config Key Store. It is considered best practice to keep that value and set up the Content Agent Provider in your key store if you haven't already. The provider key and value can be found in the config of the Content Agent and should be the URL to the editorial open content. Map the key of that property to this field - preferably through the config key store.

#### Property Mapping Overrides

The default properties extracted from articles and packages are a part of the Editorial OC standard Config. The properties `TeaserHeadline` and `TeaserBody` were added in version 0.9.1. If you have other property names in your OC, you can override them in this section.

You can exclude a field by setting the property value to `null`

**Article properties:**

```
{
  "pushHeadline": "TeaserHeadline",
  "pushBody": "TeaserBody",
  "contentHeadline": "Headline",
  "contentAuthors": "WriterAuthors",
  "contentPubDate": "WriterPubStart",
  "contentPremium": "ArticleMetaPremium",
  "contentChannels": "ArticleMetaChannels",
  "contentSections": "ArticleMetaSections",
  "contentCreatedDate": "created",
  "contentUpdatedDate": "updated",
  "contentPubStatus": "Status",
  "contentHasPublishedVersion": "WriterHasPublishedVersion",
  "contentUuid": "uuid"
}
```

**�Package properties:**

```
{
  "pushHeadline": "Name",
  "contentHeadline": "Name",
  "contentAuthors": "ObjectCreator",
  "contentPubDate": "PackagePubStart",
  "contentChannels": "Products",
  "contentSections": "PackageCategory",
  "contentCreatedDate": "created",
  "contentUpdatedDate": "updated",
  "contentPubStatus": "PackagePubStatus",
  "contentUuid": "uuid"
}
```

### **Click Action Settings**

This object in the configuration is to enable or disable the “click\_action” param in Push notification payload.&#x20;

When `enableClickAction` is set to true , system will send click\_action = "FLUTTER\_NOTIFICATION\_CLICK" in the message object of request payload.

**Click Action Settings:**

```
"clickActionSettings": {
                "enableClickAction": true
        }
```

SNS data structure for android(For reference) when `click_action` field is present in the Payload.

```
{
    "data": {
        "context": "front",
        "contentType": "article",
        "message": "Brian Stanley was first elected to Laois County Council in 1999. Picture: Gareth Chaney",
        "title": "Breaking News",
        "uuid": "ec1d34d3-0e74-4ad8-aa3b-d06e08164739"
    },
    "notification": {
        "title": "Breaking News",
        "body": "Brian Stanley was first elected to Laois County Council in 1999. Picture: Gareth Chaney",
        "click_action": "FLUTTER_NOTIFICATION_CLICK"
    },
    "time_to_live": 86400
}
```

<figure><img src="https://3082871219-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fq43mH4vu3iX3n8gaNolm%2Fuploads%2Faj9LtiXBCBPf8FuNcXhG%2Fimage.png?alt=media&amp;token=4902099d-ed69-4794-b882-49f1a4f9012f" alt=""><figcaption></figcaption></figure>
