通过事件订阅，应用可以及时响应智书开放平台中的变更事件。当事件发生时，开放平台会按照你配置的订阅方式发送事件消息。开放平台支持的事件请参考事件列表。

适用场景

下面列举一个简单的使用场景。开发者可以根据实际需求，订阅不同的事件。

实时数据处理

如果应用对数据的实时性要求比较高，希望能够及时地从智书合同同步数据的变化，可以进行事件订阅。例如在发送合同状态变更时，应用需要第一时间处理合同相关的的业务数据，就可以订阅合同状态变更事件。

订阅流程

事件订阅的基本流程如下图所示：

（可选）配置 Encrypt Key。配置 Encrypt Key 后，开放平台将推送加密后的事件。加密推送能够让用户数据更加安全。

（可选）修改 Verification Token。联系客服创建应用后，开放平台会自动为应用生成一个 Verification Token，用户也可以修改该 Token。开放平台向应用推送的事件中都带有此 Token，应用可以据此 Token 验证推送的事件是否属于该应用。

配置订阅方式。配置订阅方式用于接收开放平台向应用推送的事件消息。当应用订阅的事件发生时，开放平台会按照指定方式发送事件消息。

添加事件。选择应用需要关注的事件，汇总成表格，并联系智书客服，新增订阅的事件。

接收并处理事件。当事件发生时，开放平台会向应用推送事件，应用需要接收并处理事件。

事件结构

下面列举了一个事件示例。

schema 字段表示事件的版本。

header.event_id 字段是事件的唯一标识。

header.token 字段即 Verification Token。

header.create_time 字段表示事件发送的时间，一般近似于事件发生的时间。

header.event_type 字段表示事件类型。

event 结构体记录的是事件的详细信息，不同事件的信息不同。

{
    "schema": "2.0",
    "header": { 
        "event_id": "f7984f25108f8137722bb63cee927e66",
        "token": "066zT6pS4QCbgj5Do145GfDbbagCHGgF",
        "create_time": "1603977298000000",
        "event_type": "contact.user_group.created_v3",
        "tenant_key": "xxxxxxx",
        "app_id": "cli_xxxxxxxx",
    },
    "event":{
    }
}

事件推送

推送周期和频次

订阅的事件发生时，开放平台将会通过 HTTP POST 请求发送 JSON 格式的事件数据到预先配置的配置订阅方式。
应用收到 HTTP POST 请求后，需要在 3 秒内以 HTTP 200 状态码响应该请求。否则开放平台认为本次推送失败，并以 15秒、5分钟、1小时、6小时的间隔重新推送事件，最多重试 4 次。
从上述描述可以看出，事件重发的最长时间窗口约为 7.1 小时，请检查和处理在 7.1 小时内的重复事件。可以使用如

事件推送顺序

为了保证用户的事件可用性以及内外部数据变化一致性，对于部分事件，开放平台使用了有序事件的形式进行推送。即在用户对前一事件接收成功后，才会推送下一事件。
对于有序事件，用户需要保证相应前后事件的正常消费，避免造成事件的阻塞或收到事件不及时。
事件是否有序，则可查看对应事件页面的详细说明。

事件概述

适用场景#

订阅流程#

事件结构#

事件推送#