1N1nce
IoT Integrator

Patch Customer Webhook Integration

Patch Customer Webhook Integration

patch/v1/integrate/clouds/webhooks/{integrationId}

Request

  • Base URL
    https://api.1nce.com/management-api
  • Auth
    HTTP bearer

Path parameters

integrationIdstring required

unique integration ID

Request body

urlstring uri

URL of the webhook (HTTPS required)

headersobject

Headers that should be sent to the webhook. Only string values and no nested objects

jsonPayloadEnabledboolean

Flag if the payloads of this integration should be bridged in JSON format.

Example request

{
  "url": "https://www.example.com",
  "eventTypes": [
    {
      "type": "TELEMETRY_DATA",
      "version": "1.0.0"
    }
  ],
  "jsonPayloadEnabled": true
}

Response

Customer Webhook Integration Details.

namestring required

Name of the integration.

state'ROLLOUT_DONE' | 'INTEGRATION_ACTIVE' | 'INTEGRATION_FAILED' required

State of the integration.

type'WEBHOOK' required

Type of the integration.

idstring required

ID of the integration.

createdTimestring date-time required

Created timestamp of the integration.

updatedTimestring date-time required

Updated timestamp of the integration.

headersobject required

Headers of the integration.

urlstring uri required

URL of the integration.

jsonPayloadEnabledboolean required

Flag if the payloads of this integration should be bridged in JSON format.

Example response

{
  "name": "<integraton_name>",
  "eventTypes": [
    {
      "type": "TELEMETRY_DATA",
      "version": "1.0.0"
    }
  ],
  "state": "ROLLOUT_DONE",
  "type": "WEBHOOK",
  "id": "<integration_id>",
  "createdTime": "2022-03-07T08:51:29.015Z",
  "updatedTime": "2022-03-07T08:51:29.015Z",
  "url": "https://example.com",
  "jsonPayloadEnabled": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.