Hide child attributes
idnamehttps://manage.kontent.ai/v2/projects/{environment_id}/webhooks-vnexthttps://manage.kontent.ai/v2/projects/{environment_id}/webhooks-vnexthttps://manage.kontent.ai/v2/projects/{environment_id}/webhooks-vnext/{webhook_identifier}https://manage.kontent.ai/v2/projects/{environment_id}/webhooks-vnext/{webhook_identifier}/enablehttps://manage.kontent.ai/v2/projects/{environment_id}/webhooks-vnext/{webhook_identifier}/disablehttps://manage.kontent.ai/v2/projects/{environment_id}/webhooks-vnext/{webhook_identifier}environment_idThe webhook to be added.
nameurlsecretidnameurlenvironment_ididnameenvironment_idwebhook_identifieridnameurlenvironment_idwebhook_identifierenvironment_idwebhook_identifierenvironment_idwebhook_identifierheaders[]enableddelivery_triggerssecretheaders[]enabledlast_modifiedhealth_statusdelivery_triggersurlsecretheaders[]keyvalueenabledlast_modifiedhealth_statusdelivery_triggerssloteventscontent_typesecretheaders[]enabledlast_modifiedhealth_statusdelivery_triggersenabledactions[]actionfilterscontent_itemenabledactions[]actiontaxonomyenabledactions[]actionassetenabledactions[]actionlanguageenabledactions[]actioncontent_types[]idtransition_to[]workflow_identifieridfilterscollections[]idcontent_types[]filterstaxonomies[]idfilterslanguages[]id
step_identifierididlanguages[]idsecret value. We recommend using a CSPRNG
for this. In the UI, the secret is automatically generated for you.5df74e27-1213-484e-b9ae-bcbe90bd5990).5df74e27-1213-484e-b9ae-bcbe90bd5990).5df74e27-1213-484e-b9ae-bcbe90bd5990).5df74e27-1213-484e-b9ae-bcbe90bd5990).. This is useful if you need to send extra information, such as authentication details, along with the webhook notification body.If you specify multiple headers with the same key for the webhook, the header values will be added to a comma-separated list and sent as a single HTTP header, such as "custom_key": "value1, value2, value3".enabled property is set to true.secret value. We recommend using a CSPRNG for this. In the UI, the secret is automatically generated for you.. This is useful if you need to send extra information, such as authentication details, along with the webhook notification body.If you specify multiple headers with the same key for the webhook, the header values will be added to a comma-separated list and sent as a single HTTP header, such as "custom_key": "value1, value2, value3".enabled property is set to true. formatted date & time of the last change to the webhook. secret value. We recommend using a CSPRNG for this. In the UI, the secret is automatically generated for you.. This is useful if you need to send extra information, such as authentication details, along with the webhook notification body.If you specify multiple headers with the same key for the webhook, the header values will be added to a comma-separated list and sent as a single HTTP header, such as "custom_key": "value1, value2, value3".key can contain alphanumeric characters (a-z, A-Z, and 0-9) and the special characters - and _.key cannot be set to the following reserved keys: content-length, content-type, host, request-context, request-id, and traceparent.value can contain alphanumeric characters (a-z, A-Z, 0-9) and the following special characters: _ :;.,\/"'?!(){}[]@<>=-+*#$&`|~^%.enabled property is set to true. formatted date & time of the last change to the webhook. secret value. We recommend using a CSPRNG for this. In the UI, the secret is automatically generated for you.. This is useful if you need to send extra information, such as authentication details, along with the webhook notification body.If you specify multiple headers with the same key for the webhook, the header values will be added to a comma-separated list and sent as a single HTTP header, such as "custom_key": "value1, value2, value3".enabled property is set to true. formatted date & time of the last change to the webhook. x-kontent-aiidnameurlactions to the content types specified by references. This doesn't apply to the created action.action property to be set to workflow_step_changed.actions to the taxonomy groups specified by references. This doesn't apply to the created action.actions to the languages specified by references. This doesn't apply to the created action.. All rights reserved.secretheaders[]enabledlast_modifiedhealth_statusdelivery_triggerssecret value. We recommend using a CSPRNG for this. In the UI, the secret is automatically generated for you.. This is useful if you need to send extra information, such as authentication details, along with the webhook notification body.If you specify multiple headers with the same key for the webhook, the header values will be added to a comma-separated list and sent as a single HTTP header, such as "custom_key": "value1, value2, value3".enabled property is set to true. formatted date & time of the last change to the webhook. {
"": {
"id": "5df74e27-1213-484e-b9ae-bcbe90bd5990",
"name": "Example webhook",
"url": "https://example.com/webhook",
"secret": "fNp+QH1sE+fSXoNFlQ4kwiTJz0er2L34gFItAAVHws8=",
"headers": [
{
"key": "api-key",
"value": "Secret API key value"
},
{
"key": "Custom-key",
"value": "Custom header value with alphanum3r1c characters."
}
],
"enabled": true,
"last_modified": "2023-09-18T09:29:08.4356117Z",
"health_status": "working",
"delivery_triggers": {
"slot": "preview",
"events": "specific",
"content_type": {
"enabled": true,
"actions": [
{
"action": "changed"
}
],
"filters": {
"content_types": [
{
"id": "99efc78f-af77-4535-a553-3ae2c5fd5385"
}
]
}
},
"content_item": {
"enabled": true,
"actions": [
{
"action": "workflow_step_changed",
"transition_to": [
{
"workflow_identifier": {
"id": "131a952b-ead3-448f-84f4-644d5fea49b1"
},
"step_identifier": {
"id": "b4363ccd-8f21-45fd-a840-5843d7b7f008"
}
},
{
"workflow_identifier": {
"id": "ee4aa121-fcdf-417e-bcc2-929a94a83727"
},
"step_identifier": {
"id": "88ac5e6e-1c5c-4638-96e1-0d61221ad5bf"
}
}
]
}
],
"filters": {
"collections": [
{
"id": "a1b6c97b-0af1-4791-bdc8-b5d0556004ae"
}
],
"content_types": [
{
"id": "99efc78f-af77-4535-a553-3ae2c5fd5385"
}
],
"languages": [
{
"id": "16ec3fdb-cb3d-42ea-a179-6fd682d4a25b"
}
]
}
},
"taxonomy": {
"enabled": true,
"actions": [
{
"action": "term_changed"
}
],
"filters": {
"taxonomies": [
{
"id": "99efc78f-af77-4535-a553-3ae2c5fd5385"
}
]
}
},
"asset": {
"enabled": true,
"actions": [
{
"action": "deleted"
}
]
},
"language": {
"enabled": true,
"actions": [
{
"action": "changed"
},
{
"action": "created"
}
],
"filters": {
"languages": [
{
"id": "99efc78f-af77-4535-a553-3ae2c5fd5385"
}
]
}
}
}
}
}{
"request_id": "|f5e9980562323e4b9b23588a141d323a.2774b2ca_",
"error_code": 111,
"message": "The requested webhook was not found."
}{
"request_id": "|f5e9980562323e4b9b23588a141d323a.2774b2ca_",
"error_code": 111,
"message": "The requested webhook was not found."
}{
"request_id": "|4917a91f0f3c1640a41e5afda87f57b5.9fa110d9_",
"error_code": 111,
"message": "The requested webhook was not found."
}{
"id": "5df74e27-1213-484e-b9ae-bcbe90bd5990",
"name": "Example webhook",
"url": "https://example.com/webhook",
"secret": "fNp+QH1sE+fSXoNFlQ4kwiTJz0er2L34gFItAAVHws8=",
"headers": [
{
"key": "api-key",
"value": "Secret API key value"
},
{
"key": "Custom-key",
"value": "Custom header value with alphanum3r1c characters."
}
],
"enabled": true,
"last_modified": "2023-09-18T09:29:08.4356117Z",
"health_status": "working",
"delivery_triggers": {
"slot": "preview",
"events": "specific",
"content_type": {
"enabled": true,
"actions": [
{
"action": "changed"
}
],
"filters": {
"content_types": [
{
"id": "99efc78f-af77-4535-a553-3ae2c5fd5385"
}
]
}
},
"content_item": {
"enabled": true,
"actions": [
{
"action": "workflow_step_changed",
"transition_to": [
{
"workflow_identifier": {
"id": "131a952b-ead3-448f-84f4-644d5fea49b1"
},
"step_identifier": {
"id": "b4363ccd-8f21-45fd-a840-5843d7b7f008"
}
},
{
"workflow_identifier": {
"id": "ee4aa121-fcdf-417e-bcc2-929a94a83727"
},
"step_identifier": {
"id": "88ac5e6e-1c5c-4638-96e1-0d61221ad5bf"
}
}
]
}
],
"filters": {
"collections": [
{
"id": "a1b6c97b-0af1-4791-bdc8-b5d0556004ae"
}
],
"content_types": [
{
"id": "99efc78f-af77-4535-a553-3ae2c5fd5385"
}
],
"languages": [
{
"id": "16ec3fdb-cb3d-42ea-a179-6fd682d4a25b"
}
]
}
},
"taxonomy": {
"enabled": true,
"actions": [
{
"action": "term_changed"
}
],
"filters": {
"taxonomies": [
{
"id": "99efc78f-af77-4535-a553-3ae2c5fd5385"
}
]
}
},
"asset": {
"enabled": true,
"actions": [
{
"action": "deleted"
}
]
},
"language": {
"enabled": true,
"actions": [
{
"action": "changed"
},
{
"action": "created"
}
],
"filters": {
"languages": [
{
"id": "99efc78f-af77-4535-a553-3ae2c5fd5385"
}
]
}
}
}
}{
"id": "5df74e27-1213-484e-b9ae-bcbe90bd5990",
"name": "Example webhook",
"url": "https://example.com/webhook",
"secret": "fNp+QH1sE+fSXoNFlQ4kwiTJz0er2L34gFItAAVHws8=",
"headers": [
{
"key": "api-key",
"value": "Secret API key value"
},
{
"key": "Custom-key",
"value": "Custom header value with alphanum3r1c characters."
}
],
"enabled": true,
"last_modified": "2023-09-18T09:29:08.4356117Z",
"health_status": "working",
"delivery_triggers": {
"slot": "preview",
"events": "specific",
"content_type": {
"enabled": true,
"actions": [
{
"action": "changed"
}
],
"filters": {
"content_types": [
{
"id": "99efc78f-af77-4535-a553-3ae2c5fd5385"
}
]
}
},
"content_item": {
"enabled": true,
"actions": [
{
"action": "workflow_step_changed",
"transition_to": [
{
"workflow_identifier": {
"id": "131a952b-ead3-448f-84f4-644d5fea49b1"
},
"step_identifier": {
"id": "b4363ccd-8f21-45fd-a840-5843d7b7f008"
}
},
{
"workflow_identifier": {
"id": "ee4aa121-fcdf-417e-bcc2-929a94a83727"
},
"step_identifier": {
"id": "88ac5e6e-1c5c-4638-96e1-0d61221ad5bf"
}
}
]
}
],
"filters": {
"collections": [
{
"id": "a1b6c97b-0af1-4791-bdc8-b5d0556004ae"
}
],
"content_types": [
{
"id": "99efc78f-af77-4535-a553-3ae2c5fd5385"
}
],
"languages": [
{
"id": "16ec3fdb-cb3d-42ea-a179-6fd682d4a25b"
}
]
}
},
"taxonomy": {
"enabled": true,
"actions": [
{
"action": "term_changed"
}
],
"filters": {
"taxonomies": [
{
"id": "99efc78f-af77-4535-a553-3ae2c5fd5385"
}
]
}
},
"asset": {
"enabled": true,
"actions": [
{
"action": "deleted"
}
]
},
"language": {
"enabled": true,
"actions": [
{
"action": "changed"
},
{
"action": "created"
}
],
"filters": {
"languages": [
{
"id": "99efc78f-af77-4535-a553-3ae2c5fd5385"
}
]
}
}
}
}{
"id": "5df74e27-1213-484e-b9ae-bcbe90bd5990",
"name": "Example webhook",
"url": "https://example.com/webhook",
"secret": "fNp+QH1sE+fSXoNFlQ4kwiTJz0er2L34gFItAAVHws8=",
"headers": [
{
"key": "api-key",
"value": "Secret API key value"
},
{
"key": "Custom-key",
"value": "Custom header value with alphanum3r1c characters."
}
],
"enabled": true,
"last_modified": "2023-09-18T09:29:08.4356117Z",
"health_status": "working",
"delivery_triggers": {
"slot": "preview",
"events": "specific",
"content_type": {
"enabled": true,
"actions": [
{
"action": "changed"
}
],
"filters": {
"content_types": [
{
"id": "99efc78f-af77-4535-a553-3ae2c5fd5385"
}
]
}
},
"content_item": {
"enabled": true,
"actions": [
{
"action": "workflow_step_changed",
"transition_to": [
{
"workflow_identifier": {
"id": "131a952b-ead3-448f-84f4-644d5fea49b1"
},
"step_identifier": {
"id": "b4363ccd-8f21-45fd-a840-5843d7b7f008"
}
},
{
"workflow_identifier": {
"id": "ee4aa121-fcdf-417e-bcc2-929a94a83727"
},
"step_identifier": {
"id": "88ac5e6e-1c5c-4638-96e1-0d61221ad5bf"
}
}
]
}
],
"filters": {
"collections": [
{
"id": "a1b6c97b-0af1-4791-bdc8-b5d0556004ae"
}
],
"content_types": [
{
"id": "99efc78f-af77-4535-a553-3ae2c5fd5385"
}
],
"languages": [
{
"id": "16ec3fdb-cb3d-42ea-a179-6fd682d4a25b"
}
]
}
},
"taxonomy": {
"enabled": true,
"actions": [
{
"action": "term_changed"
}
],
"filters": {
"taxonomies": [
{
"id": "99efc78f-af77-4535-a553-3ae2c5fd5385"
}
]
}
},
"asset": {
"enabled": true,
"actions": [
{
"action": "deleted"
}
]
},
"language": {
"enabled": true,
"actions": [
{
"action": "changed"
},
{
"action": "created"
}
],
"filters": {
"languages": [
{
"id": "99efc78f-af77-4535-a553-3ae2c5fd5385"
}
]
}
}
}
}// Tip: Find more about JS/TS SDKs at https://kontent.ai/learn/javascript
import { ManagementClient } from '@kontent-ai/management-sdk';
const client = new ManagementClient({
environmentId: 'KONTENT_AI_ENVIRONMENT_ID',
apiKey: 'KONTENT_AI_MANAGEMENT_API_KEY',
});
const response = await client
.addWebhook()
.withData({
name: 'Example webhook',
url: 'https://example.com/webhook',
secret: 'secret_key',
delivery_triggers: {
slot: 'preview',
events: 'specific',
content_type: {
enabled: 'true',
actions: [
{
action: 'changed',
},
],
},
asset: {
enabled: 'true',
actions: [
{
action: 'deleted',
},
],
},
taxonomy: {
enabled: 'true',
actions: [
{
action: 'term_changed',
},
],
},
language: {
enabled: 'true',
actions: [
{
action: 'changed',
},
{
action: 'created',
},
],
},
content_item: {
enabled: 'true',
actions: [
{
action: 'workflow_step_changed',
transition_to: [],
},
],
filters: {
collections: [{}],
content_types: [{}],
languages: [{}],
},
},
},
})
.toPromise();
// Tip: Find more about JS/TS SDKs at https://kontent.ai/learn/javascript
import { ManagementClient } from '@kontent-ai/management-sdk';
const client = new ManagementClient({
environmentId: 'KONTENT_AI_ENVIRONMENT_ID',
apiKey: 'KONTENT_AI_MANAGEMENT_API_KEY',
});
const response = await client.listWebhooks().toPromise();
// Tip: Find more about JS/TS SDKs at https://kontent.ai/learn/javascript
import { ManagementClient } from '@kontent-ai/management-sdk';
const client = new ManagementClient({
environmentId: 'KONTENT_AI_ENVIRONMENT_ID',
apiKey: 'KONTENT_AI_MANAGEMENT_API_KEY',
});
const response = await client
.getWebhook()
.byId('5df74e27-1213-484e-b9ae-bcbe90bd5990')
.toPromise();
// Tip: Find more about JS/TS SDKs at https://kontent.ai/learn/javascript
import { ManagementClient } from '@kontent-ai/management-sdk';
const client = new ManagementClient({
environmentId: 'KONTENT_AI_ENVIRONMENT_ID',
apiKey: 'KONTENT_AI_MANAGEMENT_API_KEY',
});
const response = await client
.enableWebhook()
.byId('5df74e27-1213-484e-b9ae-bcbe90bd5990')
.toPromise();
// Tip: Find more about JS/TS SDKs at https://kontent.ai/learn/javascript
import { ManagementClient } from '@kontent-ai/management-sdk';
const client = new ManagementClient({
environmentId: 'KONTENT_AI_ENVIRONMENT_ID',
apiKey: 'KONTENT_AI_MANAGEMENT_API_KEY',
});
const response = await client
.disableWebhook()
.byId('5df74e27-1213-484e-b9ae-bcbe90bd5990')
.toPromise();
// Tip: Find more about JS/TS SDKs at https://kontent.ai/learn/javascript
import { ManagementClient } from '@kontent-ai/management-sdk';
const client = new ManagementClient({
environmentId: 'KONTENT_AI_ENVIRONMENT_ID',
apiKey: 'KONTENT_AI_MANAGEMENT_API_KEY',
});
const response = await client
.deleteWebhook()
.byId('d53360f7-79e1-42f4-a524-1b53a417d03e')
.toPromise();