What is a custom payload?

Custom payload is a feature that allows you to send various information to an app in JSON format via a push notification.
Specifically, when you receive a push notification, your app can read the custom payload contained in that notification and change the screen color depending on the custom payload.
null

See below for how to handle custom payloads in your app.
https://developers.karte.io/docs/app-customize-notification-payload#%E8%A8%AD%E5%AE%9A%E3%81%97%E3%81%9F%E5%80%A4%E3%81%AE%E5%8F%82%E7%85%A7%E6%96%B9%E6%B3%95

Custom payload settings in Message

KARTE Messageにおけるカスタムペイロードは「JSONデータ」を作成する形になりますが、JSONを直接記述する以外に「入力フォームを設定」し、フォームで値を追加することもできます。

null

入力フォームを設定する

以下のようなデータを「入力フォーム設定」に記載することでカスタムペイロードをフォームで入力することが可能になります。

Supplement

入力フォームで設定していた値は、未設定でもバリデーションされません。また、入力フォームで設定した以外の値もJSONデータの直接入力側で追加することができます。あくまで、JSONデータのいずれかの値を入力するサポートをするための機能となります。

null

{
  "text": {
    "type": "text"
  },
  "iconColorCode": {
    "type": "color"
  },
  "startDate": {
    "type": "date"
  },
  "endDate": {
    "type": "date"
  },
  "brandName": {
    "type": "select",
    "option": [
      {
        "label": "ほげ",
        "value": "hoge"
      },
      {
        "label": "ふが",
        "value": "fuga"
      }
    ]
  }
}

Text Field

null

入力フォーム設定

"key_name": {
  "type": "text"
}

出力されるJSONデータ

{
  "key_name": "テスト"
}

Colorpicker field

null

入力フォーム設定

"key_name": {
  "type": "color"
}

出力されるJSONデータ

{
  "key_name": "#733232"
}

dateフィールド

null

入力フォーム設定

"key_name": {
  "type": "date"
}

出力されるJSONデータ

{
  "key_name": "2024-03-06"
}

Select Field

null

入力フォーム設定

"key_name": {
  "type": "select",
  "option": [
    {
      "label": "ほげ",
      "value": "hoge"
    },
    {
      "label": "ふが",
      "value": "fuga"
    }
  ]
}

出力されるJSONデータ

{
  "key_name": "hoge"
}

important point

  • 入力フォームの「設定名」が被ると先に書かれている入力フォームが削除されてしまいます。名前が被らないように入力フォーム名を記載してください。