Updated Mon Oct 3rd 2022, 21:22 UTC

Update

PUT /integrations/:integration

Note: This endpoint is still under active development, and may change without warning.

Update the config or “active” flag of an existing Integration.

Examples

Update an Integration

Request

PUT /integrations/0yX2VrJ

Body

{
  "config": {
    "baseUrl": "https://foo.bar.com/zest",
    "clientSecret": "secret"
  },
  "active": true,
  "settings": { }
}

Example

$ curl -i -H Accept:"application/vnd.textus+jsonld" \
    -H Authorization:"Bearer {token}" \
    -X PUT /integrations/0yX2VrJ
    -d '{
  "config": {
    "baseUrl": "https://foo.bar.com/zest",
    "clientSecret": "secret"
  },
  "active": true,
  "settings": { }
}'

Response

Status

200

Response Type

Integration

Example Body

{
  "@type": "Integration",
  "@context": "/contexts/Integration.jsonld",
  "id": "/integrations/0yX2VrJ",
  "active": true,
  "provider": "webhook",
  "config": {
    "baseUrl": "https://foo.bar.com/zest",
    "webhookSecret": "textus-abcdefgh12345678",
    "clientSecret": "[FILTERED]"
  },
  "settings": {}
}