PIpiwik
Data Activation

Create webhook import

Create a new webhook import definition. Webhook import ID is optional, if absent, it'll be randomly generated. Requires manage permission.

post/api/cdp/settings/v1/app/{app_id}/webhook-import

Request

Request body

idstring uuid

ID of the webhook import

namestring required
identifiersobject

Mapping of incoming keys to profile identifiers, only cookie_id or user_id allowed as values for now.

attributesobject

Mapping of incoming keys to event data keys

status'active' | 'inactive' required

Whether the webhook import is active. Cannot be toggled if webhook import has no identifiers or attributes.

test_request_bodystring

JSON body of the webhook request to store temporarily for setting up the webhook import attribute mappings.

Example request

{
  "identifiers": {
    "email": "user_id"
  },
  "attributes": {
    "url": "analytics.event_url",
    "user.age": "age",
    "transaction_id": "session_custom_dimension_5"
  },
  "status": "inactive",
  "test_request_body": "{\"user_id\":\"test\",\"total_revenue\":1}"
}

Response

Created webhook import object.

idstring uuid required

ID of the webhook import

namestring required
identifiersobject

Mapping of incoming keys to profile identifiers, only cookie_id or user_id allowed as values for now.

attributesobject

Mapping of incoming keys to event data keys

status'active' | 'inactive' required

Whether the webhook import is active. Cannot be toggled if webhook import has no identifiers or attributes.

test_request_bodystring

JSON body of the webhook request to store temporarily for setting up the webhook import attribute mappings.

created_atstring date-time required

Time of the creation of the webhook import.

updated_atstring date-time required

Time when the webhook import's settings were updated.

Example response

{
  "author": {
    "email": "author@piwik.pro"
  },
  "identifiers": {
    "email": "user_id"
  },
  "attributes": {
    "url": "analytics.event_url",
    "user.age": "age",
    "transaction_id": "session_custom_dimension_5"
  },
  "status": "inactive",
  "test_request_body": "{\"user_id\":\"test\",\"total_revenue\":1}",
  "created_at": "2022-10-17T09:49:16.123456Z",
  "updated_at": "2022-10-17T09:49:16.123456Z"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.