Skip to main content

Export API endpoints

Kathyana Rule
  • Updated

Understand and create exports

Contents

Export API endpoints

Relative URI Method Success code Description
/exports GET 200 Get all exports.
POST 201 Create an export.
/exports/<_id> GET 200 Get a specific export.
PUT 200 Update a specific export.
DELETE 204 Delete a specific export.
/exports/<_id>/distributed GET 200 Get the distributed configuration (the fields stored directly in the export application). This API is currently needed only for Salesforce and NetSuite real-time exports.
PUT 200 Update the distributed configuration for a specific export. This API is currently needed for only Salesforce and NetSuite real-time exports.
/exports/<_id>/clone POST 201 Clone a specific export.

Export API examples

GET /v1/exports/55e••••••••••••••••••366 HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token

Sample response

{
  "_id":"55e••••••••••••••••••366",
  "lastModified":"2017-04-16T18:56:15.879Z",
  "name":"GitHub Event Listener",
  "type":"webhook",
  "hooks":{
    "preSavePage":{
      "_stackId":null,
      "function":null
    }
  },
  "webhook":{
    "provider":"github",
    "key":"••••••"
  }
}
PUT /v1/exports/55e••••••••••••••••••366 HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token

{
  "_id":"55e••••••••••••••••••366",
  "lastModified":"2017-04-16T18:56:15.879Z",
  "name":"GitHub Event Listener (updated!)",
  "type":"webhook",
  "hooks":{
    "preSavePage":{
      "_stackId":null,
      "function":null
    }
  },
  "webhook":{
    "provider":"github",
    "key":"••••••"
  }
}

Sample response

{
  "_id":"55e••••••••••••••••••366",
  "lastModified":"2017-11-28T19:37:04.180Z",
  "name":"GitHub Event Listener (updated!)",
  "type":"webhook",
  "webhook":{
    "provider":"github",
    "key":"•••••"
  }
}

Related articles

Comments

0 comments

Please sign in to leave a comment.