跳到內容

銅焊,釺人

您可以使用與釺人溝通REST API,基本上我們的API允許你做任何事。我們稱之為釺釺webhook-a webhook溝通於釺釺。

先決條件

創建一個釺釺webhook,你需要一個API密匙你想要達到的權限端點。例如,如果您正在使用/用戶/跟蹤端點,您將需要一個API密匙users.track權限。

用例

雖然有很多你可以做釺釺人,以下是一些常見的用例開始:

  • 用戶配置文件編寫或更新自定義屬性。
  • 引用一個事件屬性在畫布上的通過將事件存儲屬性的用戶配置文件屬性。
  • 增加一個整數自定義屬性為一個計數器當用戶接收一條消息。
  • 觸發第二個帆布從最初的畫布。

此頁麵上的示例用例假設您已經熟悉人是如何工作的以及如何創建一個webhook在銅焊。

步驟創建一個釺釺webhook

雖然webhook請求的細節會有所不同從用例,用例,一般工作流創建釺釺webhook保持不變。

  1. 創建一個webhook作為一個運動或帆布組件。
  2. 選擇空白模板。
  3. 在組成選項卡中,指定Webhook URL和請求體為你的用例指出。
  4. 在設置選項卡中,指定您的HTTP方法和請求頭為你的用例指出。
  5. 今後繼續構建webhook。注意,有些用例需要特定的交付設置,如觸發活動或畫布上的一個定製的事件。

用例:一個事件或屬性添加到用戶的概要文件

這個用例,你可以更新用戶的概要文件與一個事件,事件屬性,或屬性的活動或畫布上。例如,一個B2C網站可以添加一個屬性purchase_lapsers = true用戶的配置文件如果不轉換從一個廢棄的車運動或帆布允許這些用戶gdp8 %與後續消息。

另一個常見的用例是一個解決方案使事件性質貫穿人的畫布,而不隻是第一步。這涉及到添加一個事件屬性作為一個自定義的屬性,這樣您就可以參考這個事件屬性在畫布上。使用帆布持久條目屬性解決了這個問題。

按照一般的步驟創建釺釺webhook,並參考以下配置webhook時:

  • Webhook URL:你的REST端點URL緊隨其後的是/用戶/跟蹤。例如,US-06實例的URLhttps://rest.iad - 06. braze.com/users/track。
  • 請求主體:原始文本

請求頭和方法

釺需要授權的HTTP頭信息,包括你的API密鑰,另一個聲明內容類型。

  • 請求頭:
    • 授權:持票人YOUR_API_KEY
    • 內容類型:application / json
  • HTTP方法:帖子

取代YOUR_API_KEY與釺API鍵users.track權限。您可以創建一個API密匙在釺儀表板開發人員控製台>API設置,然後單擊創建新的API密匙。

請求體

添加您的用戶跟蹤請求在請求主體。有關更多細節,請參考用戶跟蹤。下麵是一個示例請求主體添加事件時這個端點的產權作為用戶的配置文件的自定義屬性:


          

           
            

             
1 2 3 4 5 6 7 8

             
{“屬性”:({“external_id”:“{{$ {user_id}}},“new_custom_attribute”:”{{event_properties。$ {your_event_property}}}”}]}

附加的設置

為你交付設置,選擇基於動作的交付。設置觸發動作“執行定製事件”和選擇行動,應該觸發這個webhook。

用例:增加一個整數計數器的定製屬性

這個用例涉及創建一個自定義的屬性和使用液體來計算一個特定操作的次數。

例如,您可能想要計算多少次用戶看到一個活躍的應用信息活動,並阻止他們接受競選之後他們已經看過三次。更多的想法你可以做什麼與液體邏輯在釺,看看我們的液體用例庫。

按照一般的步驟創建釺釺webhook,並參考以下配置webhook時:

  • Webhook URL:你的REST端點URL緊隨其後的是/用戶/跟蹤。例如,US-06實例的URLhttps://rest.iad - 06. braze.com/users/track。
  • 請求主體:原始文本

請求頭和方法

釺需要授權的HTTP頭信息,包括你的API密鑰,另一個聲明內容類型。

  • 請求頭:
    • 授權:持票人YOUR_API_KEY
    • 內容類型:application / json
  • HTTP方法:帖子

取代YOUR_API_KEY與釺API鍵users.track權限。您可以創建一個API密匙在釺儀表板開發人員控製台>API設置,然後單擊創建新的API密匙。

請求體

添加您的用戶跟蹤請求在請求主體以及液體分配一個計數器變量。有關更多細節,請參考用戶跟蹤。

下麵是一個示例所需的液體和請求主體對於這個端點,your_attribute_count是你使用的屬性數多少次用戶看到的信息:


          

           
            

             
1 2 3 4 5 6 7 8 9

             
{%分配new_number={{美元custom_attribute。{your_attribute_count}}}|加:1%}{“屬性”:({“external_id”:“{{$ {user_id}}},“your_attribute_count”:“{{new_number}}”}]}

用例:觸發第二個帆布從最初的畫布

在此用例中,您將創建兩個畫布和使用webhook引發第二次從第一個帆布畫布。這就像一個條目觸發當用戶到達某一點在另一個畫布。

  1. 首先創建第二個Canvas-the畫布,應該由你最初的畫布。
  2. 的帆布項計劃中,選擇API-Triggered。
  3. 注意你帆布ID在以後的步驟中,您將需要這個。
  4. 繼續構建你的第二個步驟的畫布,然後保存畫布上。
  5. 最後,創建您的第一個畫布。找到你想要的步驟觸發第二webhook畫布和創建一個新的一步。

參考以下配置webhook時:

  • Webhook URL:你的REST端點URL緊隨其後的是帆布/觸發/發送。例如,US-06實例的URLhttps://rest.iad - 06. braze.com/canvas/trigger/send。
  • 請求主體:原始文本

請求頭和方法

釺需要授權的HTTP頭信息,包括你的API密鑰,另一個聲明內容類型。

  • 請求頭:
    • 授權:持票人YOUR_API_KEY
    • 內容類型:application / json
  • HTTP方法:帖子

取代YOUR_API_KEY與釺API鍵canvas.trigger.send權限。您可以創建一個API密匙在釺儀表板開發人員控製台>API設置,然後單擊創建新的API密匙。

請求體

添加你帆布/觸發/發送請求的文本字段。有關更多細節,請參考通過API-triggered發送帆布消息交付。下麵是一個例子,這個端點的請求主體your_canvas_id從第二個帆布畫布ID:


          

           
            

             
1 2 3 4 5 6 7 8

             
{“canvas_id”:“your_canvas_id”,“收件人”:({“external_user_id”:“{{$ {user_id}}}}]}

必須知道的5件事情

  • 釺釺人受端點速度限製。
  • 更新用戶配置文件將產生額外的數據點,而通過消息端點不會觸發另一個消息。
  • 如果你想要的目標匿名用戶,你可以使用braze_id而不是external_id在webhook的請求主體。
  • 您可以保存您的釺釺webhook作為模板再次被重用。
  • 你可以檢查信息活動日誌查看和解決webhook失敗。
編輯這個頁麵在GitHub上
這個頁麵是有用嗎?
新東西!
Baidu
map