json/v1.0/sub.json in sk_api_schema-0.2.2 vs json/v1.0/sub.json in sk_api_schema-0.2.3
- old
+ new
@@ -1,8 +1,8 @@
{"type":"object",
"title": "sub",
- "description": "Subscribe to push notifications(webhooks) about object livecycle events like new, update or delete. Only returns subscription for the current app, so you MUST be using oAuth. When a user removes your app its subs are also deleted. <br/>To register you must supply <br/>- callback_url: receives the object in it's latest state, the user_id & subdomain, company_id, hmac-signed with your app secret.<br/>- channel: defining the event, made up of the SINGULAR object name and the action: invoice.delete, payment.new<br/> - register auth_permissions: An app MUST request non-api permissions f.ex.: clients:create. Perms(on company,app,user,team) are checked before any publishing, so if a user cannot create clients in the interface, his apps will not receive any callbacks.",
+ "description": "Subscribe to push notifications(webhooks) about object livecycle events like new, update or delete. Only returns subscription for the current app, so you MUST be using oAuth. When a user removes your app its subs are also deleted. <br/>To register you must supply <br/>- callback_url: receives a base64 encode string containing a JSON object with the object in it's latest state, the user_id & subdomain, company_id, hmac-signed with your app secret.<br/>- channel: defining the event, made up of the SINGULAR object name and the action: invoice.delete, payment.new<br/> - register auth_permissions: An app MUST request non-api permissions f.ex.: clients:create. Perms(on company,app,user,team) are checked before any publishing, so if a user cannot create clients in the interface, his apps will not receive any callbacks.",
"properties": {
"id": {
"identity":true,
"readonly":true,
"type":"string"
@@ -11,18 +11,12 @@
"description": "The channel to which to subscribe. See available at subs/channels.",
"required":true,
"type":"string"
},
"callback_url": {
- "description": "An url receiving the notification. The url MUST be within the url of the current app",
+ "description": "An url receiving the notification. The url MUST be within the url of the current app and receives a POST with a single signed_request parameter containing an base64 encoded JSON object.",
"type":"string",
"required":true
- },
- "http_method": {
- "description": "HTTP method used for the request, defaults to POST",
- "type":"string",
- "default":"POST",
- "enum":["POST","GET", "DELETE", "PUT"]
},
"created_at": {
"description": "Date the record was created in SK. Never changes afterwards.",
"format":"date-time",
"readonly":true,
\ No newline at end of file