Sign in
latestOpenAPI 3.1.02026-08-171503582.2 MB

6199a9464227

Data Set Incoming Webhooks

Create an incoming webhook for a data set

Creates an incoming webhook for a data set. When the webhook URL receives a JSON payload, it creates or updates data set rows using the configured column mappings.

config.columns maps data set column IDs to JSON path expressions in the incoming payload. Each key is a column ID (Muid), each value is a JSON path (e.g. $.contact.email).

config.keyColumn (optional) specifies a column used as a unique key for upserts. When set, incoming payloads update existing rows matching the key value. When absent, every payload creates a new row.

post/data-sets/{dataSetId}/incoming-webhooks

Path parameters

dataSetIdstring required

The ID of the Data Set

Request body

namestring required

Display name.

automationAppstring required

Response

Example response

{
  "data": {
    "createdBy": {
      "id": "naAJxoDIuwdgNsQHGRRGqA",
      "email": "jane.doe@example.com",
      "username": "Jane Doe"
    },
    "updatedBy": {
      "id": "naAJxoDIuwdgNsQHGRRGqA",
      "email": "jane.doe@example.com",
      "username": "Jane Doe"
    },
    "dataSetId": "nwOFXAKVeg2k-0tFOblGmQ",
    "links": [
      {
        "href": "https://api.process.st/api/v1.1/resource/XXX"
      }
    ]
  },
  "links": [
    {
      "href": "https://api.process.st/api/v1.1/resource/XXX"
    }
  ]
}