# 配置WebHook

## 配置WebHook事件

  **在推送模板、上行回复等信事件时，当无法识别或匹配到App时，数据将推送到默认应用，此时如果没有默认应用，将不推送。**  

1、 在API Keys功能菜单列表，点击回调事件配置按钮，开始进行配置

<figure><img src="https://1499599450-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fsbd17k8pYGOpOfBIUKqm%2Fuploads%2FPjpLX7HMHkVCFf7ZPDBB%2Fimage.png?alt=media&#x26;token=62d6237f-6c33-4f41-9513-9379d937ada1" alt=""><figcaption></figcaption></figure>

2、点击【Add】按钮进行添加

<figure><img src="https://1499599450-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fsbd17k8pYGOpOfBIUKqm%2Fuploads%2FInAgUHn1d2I3jvZRvPzp%2Fimage.png?alt=media&#x26;token=e2baafe5-3b10-42fa-9384-40e9158a0d34" alt=""><figcaption></figcaption></figure>

3、从可用产品列表中选择需要配置的WebHook的产品

<figure><img src="https://1499599450-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fsbd17k8pYGOpOfBIUKqm%2Fuploads%2FCqgUPRWrJNhz51S43VTk%2Fimage.png?alt=media&#x26;token=5d387c4e-b5af-4082-8dde-3ca48ca34b75" alt=""><figcaption></figcaption></figure>

4、配置回调地址，并配置选择需要接收的事件，点击Next进行下一步

<figure><img src="https://1499599450-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fsbd17k8pYGOpOfBIUKqm%2Fuploads%2FdIkB7qagt3c1A6PwtRpw%2Fimage.png?alt=media&#x26;token=5dbb39f3-1d74-44ce-a29b-42991acf5b39" alt=""><figcaption></figcaption></figure>

5、选址回调请求方式，默认POST，如果客户业务系统需要对Webhook的来源进行验签，可以配置UserName和Authorization 头信息，在WebHook 通知推送时，将会在头信息中添加UserName和Authorization，将客户配置的信息一起推送到客户系&#x7EDF;**。**

<figure><img src="https://1499599450-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fsbd17k8pYGOpOfBIUKqm%2Fuploads%2FzGKPXZQ4bM9Ja4AFDlyM%2Fimage.png?alt=media&#x26;token=52655978-16a4-43e1-bedb-c67430fb4def" alt=""><figcaption></figcaption></figure>

## WebHook公共参数

<table data-header-hidden><thead><tr><th width="107.8046875"></th><th width="92.015625"></th><th width="68.08203125"></th><th></th></tr></thead><tbody><tr><td>字段</td><td>数据类型</td><td>是否必填</td><td>描述</td></tr><tr><td>id</td><td>String</td><td>是</td><td>文件句柄，标记</td></tr><tr><td>type<br></td><td>String<br></td><td>是</td><td>事件类型:<strong>whatsapp_message_status_updated</strong>:消息状态报告 (可用) <strong>whatsapp_mo_message_received</strong>:上行消息 (可用)<strong>whatsapp_template_status_updated</strong>: 模板状态更新 (可用) <strong>whatsapp_account_review_updated</strong>:账号审核状态更新 (更新中) <strong>whatsapp_phone_number_name_update</strong>:发送号码名称更新 (更新中) </td></tr><tr><td>eventTime</td><td>String</td><td>是</td><td>Event时间，eg: 2023-02-22 12:00:00</td></tr><tr><td>body</td><td>JOSN</td><td>是</td><td>消息体</td></tr></tbody></table>