Documentation
In all the examples below, $WEBSITE
is an integer ID and $KEY
is a
SHA1 hash. Both values are generated for you and can be copied from
your website’s “Integration” page within the Sapien CI Dashboard.
Travis CI
Add a webhook notification to your .travis.yml
configuration file.
# In your `.travis.yml` file.
notifications:
webhooks: https://in.sapien-ci.com/travis/$WEBSITE/$KEY
Circle CI
Add a webhook notification to your circle.yml
configuration file.
notify:
webhooks:
- url: https://in.sapien-ci.com/circle/$WEBSITE/$KEY
Heroku
Add a deploy hook addon to your Heroku application.
$ heroku addons:create deployhooks:http \
--url=https://in.sapien-ci.com/heroku/$WEBSITE/$KEY
Adding deployhooks:http to myapp...Done.
Webhook
Make an HTTP POST request to a URL following the pattern:
https://in.sapien-ci.com/webhook/$WEBSITE/$KEY
With a JSON body containing a top level deploy
object with an id
that uniquely identifies the deploy / change event for this website:
{"deploy": {"id": $ID}}
The $ID
value can be an integer or a string (upto 64 characters). Good candidate values include a release number, deploy timestamp or commit hash.
You can dispatch HTTP POST requests using a command line tool like curl, software libraries like Requests (Python) or httpclient (Ruby), or a webhook task queue like nTorque.
$ curl -X POST -H "Content-Type: application/json"
-d "{\"deploy\": {\"id\": \"$(date +"%s")\"}}" \
'https://in.sapien-ci.com/webhook/$WEBSITE/$KEY'
Send an email to $WEBSITE+$KEY@inbound.sapien-ci.com
with a subject line
of $ID
that uniquely identifies the deploy / change event for this website.
The $ID
value can be an integer or a string (upto 64 characters). Good candidate values include a release number, deploy timestamp or commit hash.
The body of the email is currently ignored.
# Email
to: $WEBSITE+$KEY@inbound.sapien-ci.com
subject: $ID