Admin - Webhooks

APIs for configuring webhooks. Receive real-time notifications when content or other resources change.

Get Webhooks GET

Lists all webhooks configured for the project.

GET /{project}/admin/webhooks

Path Parameters

Name	Type	Required	Description
project	string	Yes	-

Response (200 OK)

[
  {
    "id": "string",
    "projectId": "string",
    "name": "string",
    "url": "string",
    "enabled": true,
    "includePayload": true,
    "createdAt": "2024-01-15T12:00:00Z",
    "createdBy": "string",
    "modifiedAt": "2024-01-15T12:00:00Z",
    "modifiedBy": "string",
    "headers": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "entityType": "string",
    "events": [
      "string"
    ],
    "entityTypeIds": [
      "string"
    ]
  }
]

cURL Example

curl -X GET "https://my-project.atlascms.io/{project}/admin/webhooks" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"

Create Webhook POST

Creates a new webhook to receive events. Configure URL, events, and authentication.

POST /{project}/admin/webhooks

Path Parameters

Name	Type	Required	Description
project	string	Yes	-

Request Body

{
  "name": "string",
  "url": "string",
  "enabled": true,
  "includePayload": true,
  "headers": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "entityType": "string",
  "events": [
    "string"
  ],
  "entityTypeIds": [
    "string"
  ]
}

Response (200 OK)

{
  "result": "string"
}

cURL Example

curl -X POST "https://my-project.atlascms.io/{project}/admin/webhooks" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"name":"string","url":"string","enabled":true,"includePayload":true,"headers":[{"key":"string","value":"string"}],"entityType":"string","events":["string"],"entityTypeIds":["string"]}'

Get Webhook GET

Retrieves a single webhook configuration by ID.

GET /{project}/admin/webhooks/{id}

Path Parameters

Name	Type	Required	Description
id	string	Yes	-
project	string	Yes	-

Response (200 OK)

{
  "id": "string",
  "projectId": "string",
  "name": "string",
  "url": "string",
  "enabled": true,
  "includePayload": true,
  "createdAt": "2024-01-15T12:00:00Z",
  "createdBy": "string",
  "modifiedAt": "2024-01-15T12:00:00Z",
  "modifiedBy": "string",
  "headers": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "entityType": "string",
  "events": [
    "string"
  ],
  "entityTypeIds": [
    "string"
  ]
}

cURL Example

curl -X GET "https://my-project.atlascms.io/{project}/admin/webhooks/item-id" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"

Update Webhook PUT

Updates an existing webhook's configuration.

PUT /{project}/admin/webhooks/{id}

Path Parameters

Name	Type	Required	Description
id	string	Yes	-
project	string	Yes	-

Request Body

{
  "name": "string",
  "url": "string",
  "enabled": true,
  "includePayload": true,
  "headers": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "entityType": "string",
  "events": [
    "string"
  ],
  "entityTypeIds": [
    "string"
  ]
}

Response (200 OK)

{
  "id": "string",
  "projectId": "string",
  "name": "string",
  "url": "string",
  "enabled": true,
  "includePayload": true,
  "createdAt": "2024-01-15T12:00:00Z",
  "createdBy": "string",
  "modifiedAt": "2024-01-15T12:00:00Z",
  "modifiedBy": "string",
  "headers": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "entityType": "string",
  "events": [
    "string"
  ],
  "entityTypeIds": [
    "string"
  ]
}

cURL Example

curl -X PUT "https://my-project.atlascms.io/{project}/admin/webhooks/item-id" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"name":"string","url":"string","enabled":true,"includePayload":true,"headers":[{"key":"string","value":"string"}],"entityType":"string","events":["string"],"entityTypeIds":["string"]}'

Delete Webhook DELETE

Removes a webhook. It will no longer receive events.

DELETE /{project}/admin/webhooks/{id}

Path Parameters

Name	Type	Required	Description
id	string	Yes	-
project	string	Yes	-

cURL Example

curl -X DELETE "https://my-project.atlascms.io/{project}/admin/webhooks/item-id" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"