Intervals API Advanced Configuration

The Intervals API allows you to pass advanced configuration options with each request through HTTP headers. Including these options allows you to define how you want the system to handle your data.

You're already familiar with the two conventional HTTP headers that instruct the API how to receive and return data.

• The Accept header tells the API which response format you prefer (either application/xml or application/json).
• The Content-type header tells the API which data format to expect from you on PUT and POST requests (either application/xml or application/json).

But you can also use the following custom headers within the API. Their behavior is described below.

X-Intervals-Send-Notifications

By default, the API does not send out email notifications when actions are performed. This is so that application developers can implement their own notification schemes. You can re-enable email notifications by passing this header.

The following example shows how to enable email notifications when a project note is added.

POST /projectnote/ HTTP/1.0
Host: api.myintervals.com
Accept: application/xml
Content-type: application/xml
Authorization: Basic TVlBUElUT0tFTjpY
X-Intervals-Send-Notifications: t

X-Intervals-Disable-Action-Notes

By default, the API will add notes to certain resources (namely tasks and milestones) when elements of it change. This mimics the same behavior as the application. You can bypass the creation of these notes by passing this header.

POST /projectnote/ HTTP/1.0
Host: api.myintervals.com
Accept: application/xml
Content-type: application/xml
Authorization: Basic TVlBUElUT0tFTjpY
X-Intervals-Disable-Action-Notes: t