webhook通知

Cloudinary提供 webhook通知功能,通知后端某些行动已经完成,或是通过API方法调用或通过ConsoleUI内用户动作完成动作完成后,HTTPPOST请求寄送公共通知URL有效载荷包含与该特定动作有关的所有结果

webhook通知使用方式如下:

• 处理异步调用.默认云式上传a同步工作上传资产处理和热切变换上传API调用时同步生成,这意味着原资产和衍生资产可立即交付和进一步管理在某些情况下,你可能需要通知上传已完成,或你可能想异步处理后台动作,特别是需要较长时间处理并需要用户积极等待处理完成的行动
• 系统其他用户修改时保持对齐.监听系统修改并相应更新很重要 以确保没有前后矛盾可设置代码监听通知并用数据自动更新举例说,您可搭建 webhook接收资产重命名通知,并启动搜索并替换以更新资产名称
• 币游国际真人娱乐云形综合平台.币游国际真人娱乐使用云化资产时 监听云化资产变换以保持同步例举,您可搭建结构元数据字段以表示资产应发布还是非发布币游国际真人娱乐等从平台内收到通知表示元数据字段变换时,触发代码中的适当动作

  币游国际真人娱乐更多资料说明如何将云形与另一个平台相融合,见如何构建自身集成.

• 触发新操作如果动作必须跟踪特定事件,您可以监听事件并用它触发动作举例说,使用通知资产上传触发资产添加目录
  实例

  云化解决团队利用此选项创建 开源库可达 学习并用名自动标签脸使用亚马逊rekognitionlibda函数

全局通知URL

可设置一个或多个全局通知URLwebhook通知页面控制台设置或programmatically使用触发器方法管理员API.

单通知或多通知URL后,云形自动向适当的URL地址发送响应控制台UI执行或调用相关云化API方法正制作

使用单通知URL时配置它接收所有通知

增法多通知URLs允许您具体说明哪个目的地接收通知币游国际真人娱乐控制水平很容易触发流或同步生态多部分并允许你:

• 指定单列通知URL处理与您工作流相关的动作
• 组织您的目的地
• 向多端点传播流量以避免性能问题

提示和考量添加多通知URL

• 确保将代码中监听的每一种通知类型分配到至少一个通知URL
• 可选择设置一个通知URL接收所有响应备份
• 通知URL可处理数例事件类型,反之,单例通知类型回复可发送至数例通知URL

管理全局通知URL

可管理Webhook通知webhook通知控制台页面或使用触发器odminAPI方法可配置最多10个通知URL

控制台内,每个通知URL都链接到所有配置通知类型事件触发程序化管理 webhook通知时 使用触发程序单触发事件加单通知URL结果,程序生成触发器反射控制台,要么生成带单词的新通知URL通知类型或附加新通知类型转到现有 URL 通知列表

管理控制台 webhook通知

要管理多通知URL 通过云控制台,转到webhook通知控制台设置页面

默认时添加新通知URL时默认-所有通知选项设置为默认类型如果您使用单通知URL或想使用单通知URL作为所有事件备份,请保留默认行为

也可以(或选择)添加不同的通知URLs选择主控UI动作和/或API方法通知类型需要在每个URL上通知

并选择访问密钥验证所有通知签名更多信息见webhook通知专用访问密钥.

webhook通知程序化管理

程序化管理通知URL使用触发器方法管理员API.中选触发程序表示独有事件类型连接通知URL产品环境支持触发最大值,通过十大通知URL乘以唯一事件类型数

事件指定类型发生时,回复寄送至相应的通知URL

举例说 搭建https://mysite.example.com/my_notification_endpointURL接收通知上传完成时间 :

API方法调用通知

调用某些API方法时,回复寄送通知URL

全表触发动作可见表格显示.

例子显示这些类型行动对通知响应,见通知响应示例段内

控制台UI通知

用户执行控制台UI下的任何下列动作时,会向通知URL发送回复

• 上传新资产
• 重命名资产公开身份证
• 删除资产删除文件夹内资产还触发删除通知注释删除空空文件夹不发送通知
• 更新资产显示名专供产品环境使用动态文件夹模式.)
• 移动文件夹间资产
  • 内固定文件夹模式下,向媒体库内另一个文件夹移动资产修改公共标识值触发重命名通知
  • 内动态文件夹模式,移动资产到另一个文件夹修改资产文件夹值触发移动通知
• 添加、删除或更新资产上下文元数据
• 添加、删除或更新资产结构元数据
  
• 添加或删除资产标签
• 更新资产访问控制设置
• 创建新资产文件夹
• 删除资产文件夹

全表触发动作可见表格显示.

从这些类型操作中通知响应的一些例子见通知响应示例段内

通知有效加载

触发通知动作完成后,HTTPPPOST请求将发送至通知URL日志数据将包含所有触发动作结果细节POST请求主体基本与响应标准同步请求时所得信息相同

上传完成后由Cloudinary发送请求

云形签名所有通知响应 允许你验证它们不是第三方寄送通知中都包含aX-Cld信号页眉和X-Cld-Timestamp校验通知响应头更多细节见验证通知签名.

更多例子说明各种API调用通知响应见通知响应示例.

通知URL专用API调用

特定情况下,您可能想在方法调用完成后立即通知后端,例如处理用户从浏览器或移动设备启动上传时通知后端填全方法后,可通知云行通知程序notification_url参数对方法调用并设置为任何有效HTTP或HTTPSURL

上传API方法支持notification_url参数 :上传,显式,爆炸,generate_archive,状图,多维并创建链路.

例举添加notification_url专用上传调用 :

eager变换通知

可指令云形发送单列通知爱心变换通过添加补全eager_notification_url参数对方法调用并设置为任何有效HTTP或HTTPSwebhook URLeager变换应安装在上传补全后后背景异步工作热切async参数详解见异步变换)急通知补充通过可选发送的任何通知notification_url参数化

上传API方法支持eager_notification_url参数 :上传并显式.

举例说,下列方法上传样本jpg图像并热切生成两种变换图像

1. 偏宽高度300像素
2. 裁剪宽度160像素和高度100像素

此外,图像完成上传后将异步执行变换,调回URL通知程序完成后通知程序,另回调URL通知程序热切变换完成后通知程序

通知加热

下表显示增用不同通知参数的结果,同时请求热切变换热切async参数化

参数解析	结果
热切并 notification_url	上传方法响应notification_url后寄完成上传 热切转换完成
热切并 eager_notification_url	上传方法响应eager_notification_url后寄完成上传 热切转换完成
热切并 eager_notification_url并 热切async	上传方法响应完成后发送并包括批量跟踪急切作业 -eager_notification_url热切变换完成批量识别后发送
热切并 notification_url并 eager_notification_url	上传方法响应notification_url后寄完成上传 热切转换完成热通知忽略
热切并 notification_url并 eager_notification_url并 热切async	上传方法响应notification_url上传完成后发送并包含批量识别跟踪急切任务 -eager_notification_url热切变换完成批量识别后发送

敏捷通知响应

热切变换完成后,HTTPPST请求寄送热通知URL,详细介绍请求热切变换,包括HTTP和HTTPS访问衍生图像例举 :

云形签名所有通知响应 允许你验证它们不是第三方寄送通知中都包含aX-Cld信号页眉和X-Cld-Timestamp校验通知响应头更多细节见验证通知签名.

热切变换不因某种原因产生,通知响应中将包括状态:失效和原因,例如:

通知响应示例

本节举几个例子说明对各种API调用或媒体库操作通知响应切记此列表不全面,回复的确切内容取决于随相关API调用或媒体库实际操作发送选项

标签标签

上下文

元数据

重命名

改变公有身份证

修改显示名

只支持产品环境使用动态文件夹模式化

创建文件夹

创建资产文件夹

资产文件夹间移位

只支持产品环境使用动态文件夹模式化

移动资产文件夹

只支持产品环境使用动态文件夹模式化

删除资产

删除资产文件夹

只支持产品环境使用动态文件夹模式化

sprite生成

多代

Exprode模拟

创建拼贴

上传(简单化)

上传(复合)

存取控制

图片从媒体库部件插入

重试策略

万一通知URL失效,HTTP响应码评估if响应非200OK启动三次通知尝试

• 三分钟后重试
• 6分钟后第二次尝试
• 九分钟后最后重试

故障排除

理解解答通知故障并识别通知可能达不到目的地URL对无缝操作至关重要在此,我们探索常见故障因子和避免潜在陷阱的方法 与云形Webhook通知合作

常见失效原因

• 有效载荷腐败:Webhook通知检验有效载荷验证,如果数据满足预期格式化和匹配系统需求失效信号数据腐败问题影响处理

• 无效签名:验证签名可能失效,并导致webhook故障

• 禁止访问密钥:使用禁用访问密钥签名API可撞击webhook功能激活访问密钥存取密钥控制台设置页面

• 无效 Webhook URL: webhook配置错误或不可访问通知URL举例说,你可能配置了一个端点并不存在,或URL路径的修改可能无法在配置中更新

• 连接超时:如果服务器经历延时超过20秒限值,则可能发生超时错误瞬态问题重试发生,但持续服务器慢化可能导致通知失效

避免潜在陷阱之道

搭建并维护Webhoots时,

• 检查签名计算:确认您的签名计算精确性这对于webhook成功至关重要

• 保证JSON有效载荷正确字符串JSON有效载荷绑定可能遇到问题,如数据丢失、无效JSON和字符编码错配这些问题可以通过使用标准库、验证JSON数据并正确处理特殊字符避免

• 标准化hash方法币游国际真人娱乐:当云平台使用不同方法安全 webhook数据时,它可能导致签名错配,导致webhook故障避免使用哈希算法规范化或实施软签名验证

• 避免通知超载:确保服务器处理通知量,特别是多上传时处理量

• HTTP头规范HTTP信头按HTTPV2规范处理不敏感案例

• 监控端点日志:定期检查端点日志500错误识别云通知处理问题