Setting up CloudSignal webhooks
Why signals
Getting status signals back to your app is an important step, it allow you to:
- keep track of the order production state
- provide your end user with tracking information
- get notified if there is an issue with the order causing a delay
- get notified if the order can not be produced and gets cancelled
Subscribing to signals via CloudApps API
Overview
- Create an endpoint that support CloudSignal Webhooks 2.0
- Authendicate with OAuth2 - App Authentication with OAuth2
- Call the CloudApps API to sebscribe/unsubscribe
Create subscription
To create a new CloudSignal subscription call this endpoint with the url and CloudApps will create a new CloudSignal Webhooks configuration. This can also be found in the Cloudprinter admin dashboard.
endpoint
https://api.cloudprinter.com/cloudapps/1.0/cloudsignal/webhooks
Method: POST
Post JSON parameters:
Key | Value |
---|---|
url | The Cloudsignal Webhook 2.0 compatible endpoint to call |
Return JSON valus:
Key | Value |
---|---|
id | Reference id to the CloudSignal Webhook configuration created in Cloudprinter.com, you need this reference id when you want to unsubscribe. |
Delete subscription
The CloudSignal subscription can at anytime be unsibscribed. Call this endpoint with the CloudSignal webhook configuration id you got when creating it. Use a HTTP DELETE method and add the id to the query string. This can also be found in the Cloudprinter admin dashboard.
endpoint
https://api.cloudprinter.com/cloudapps/1.0/cloudsignal/webhooks/<id>
Method: DELETE
Query string parameters:
Key | Value |
---|---|
id | Reference id to the CloudSignal Webhook interface created in Cloudprinter.com. This was given when the subscription was created. |