Sign in

v1

latestOpenAPI 3.0.02026-07-2417611.8 MB
Webhook profiles

Retrieves the webhook profile for the current tenant

Use the /profile end-point to retrieve the webhook profile from the database.<br />User roles: admin

get/webhook/v1/profile

Query parameters

fieldsstring

Only the content type fields that are specified here are returned for each result. Any type document field is a valid value and can be specified as a comma-separated list.

Headers

If-None-Matchstring

Provide an Etag value from a previous request to check whether the webhook profile retrieved is the most recent version. If the webhook is the most recent version, the call returns a 304 ( Not modified) message instead of sending the webhook profile back.

Response

Success.

idstring

The ID of the webhook profile

revstring

The current revision of the webhook profile.

classification'webhook-profile'
creatorIdstring

The ID of the user that created the webhook profile.

createdstring date-time

The created date of this webhook profile in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ.

lastModifierIdstring

The ID of the user that last modified the webhook profile.

lastModifiedstring date-time

The last modified date of this webhook profile in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ.

Example response

{
  "webhooks": [
    {
      "url": "http://www.my-webhook.com/myHooks",
      "filter": {
        "eventType": [
          "create",
          "update"
        ],
        "classification": [
          "asset",
          "category",
          "content"
        ],
        "status": [
          "draft",
          "ready"
        ],
        "tags": [
          "tag1",
          "processMe"
        ]
      }
    }
  ]
}