List webhook imports

get https://{account}.piwik.pro/api/cdp/settings/v1/app/{app_id}/webhook-import

Returns all registered webhook imports for the given app.

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

array of objects

object

uuid

required

ID of the webhook import

author

object

required

Author of a webhook

name

string

required

length between 1 and 255

identifiers

object

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

Has additional fields

attributes

object

Mapping of incoming keys to event data keys

Has additional fields

status

string

required

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

active inactive

test_request_body

string

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

created_at

date-time

required

Time of the creation of the webhook import.

updated_at

date-time

required

Time when the webhook import's settings were updated.

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://example.piwik.pro/api/cdp/settings/v1/app/app_id/webhook-import \
3
     --header 'accept: application/vnd.api+json'


xxxxxxxxxx
21
 
1
[
2
  {
3
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4
    "author": {
5
      "email": "author@piwik.pro"
6
    },
7
    "name": "string",
8
    "identifiers": {
9
      "email": "user_id"
10
    },
11
    "attributes": {
12
      "url": "analytics.event_url",
13
      "user.age": "age",
14
      "transaction_id": "session_custom_dimension_5"
15
    },
16
    "status": "inactive",
17
    "test_request_body": "{\"user_id\":\"test\",\"total_revenue\":1}",
18
    "created_at": "2022-10-17T09:49:16.123456Z",
19
    "updated_at": "2022-10-17T09:49:16.123456Z"
20
  }
21
]

List webhook imports

Get the full experience

Analytics

200List of registered webhook imports.

400Bad request response (e.g. missing GET parameter, parameter value out of bounds)

401Access token is missing or invalid

402CDP module is disabled

404Resource not found (bad ID or resource deleted)

500Internal application error response (some service encountered unexpected error)

Get the full experience

Analytics