Articles

Server

Article and content management

Webhook: Article created

POST

https://common-api.karma.life

/webhook/article.created

Fired when a new article is created. The full Article object is spread into data.

This is an outbound webhook event. Karma POSTs this payload to the URL you registered via POST /api/v1/webhooks/subscriptions. Your endpoint should respond 2xx within 30 seconds to acknowledge delivery.

Webhook: Article created › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

article.created

resource

string · enum · required

Enum values:

article

resourceId

string · required

String ID of the affected resource

timestamp

string · date-time · required

ISO 8601 timestamp when the event was emitted

apiVersion

string · enum · required

Enum values:

object · required

Webhook: Article created › Responses

200

Acknowledged. Karma considers any 2xx response a successful delivery; non-2xx triggers retry with exponential backoff.

No data returned

POST/webhook/article.created

curl --request POST \
  --url https://common-api.karma.life/webhook/article.created \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "evt_01HZK3...",
  "event": "article.created",
  "resource": "article",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "title": "title",
    "content": {},
    "authorRetailerUserId": 0,
    "tags": [
      "string"
    ],
    "status": "DRAFT",
    "imageUrl": "https://www.example.com/path/to/resource",
    "slackMessage": "slackMessage",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}
'

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "article.created",
  "resource": "article",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "title": "title",
    "content": {},
    "authorRetailerUserId": 0,
    "tags": [
      "string"
    ],
    "status": "DRAFT",
    "imageUrl": "https://www.example.com/path/to/resource",
    "slackMessage": "slackMessage",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}

json

Example Responses

No example specified for this content type

Webhook: Article updated

POST

https://common-api.karma.life

/webhook/article.updated

Only the modified fields appear in changes.

Webhook: Article updated › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

article.updated

resource

string · enum · required

Enum values:

article

resourceId

string · required

String ID of the affected resource

timestamp

string · date-time · required

ISO 8601 timestamp when the event was emitted

apiVersion

string · enum · required

Enum values:

object

Webhook: Article updated › Responses

200

Acknowledged. Karma considers any 2xx response a successful delivery; non-2xx triggers retry with exponential backoff.

No data returned

Webhook: Article deleted

POST

https://common-api.karma.life

/webhook/article.deleted

Soft delete.

Webhook: Article deleted › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

article.deleted

resource

string · enum · required

Enum values:

article

resourceId

string · required

String ID of the affected resource

timestamp

string · date-time · required

ISO 8601 timestamp when the event was emitted

apiVersion

string · enum · required

Enum values:

object

Webhook: Article deleted › Responses

200

Acknowledged. Karma considers any 2xx response a successful delivery; non-2xx triggers retry with exponential backoff.

No data returned

Webhook: Article published

POST

https://common-api.karma.life

/webhook/article.published

Fired when an article transitions from DRAFT to PUBLISHED. The full Article object is spread into data.

Webhook: Article published › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

article.published

resource

string · enum · required

Enum values:

article

resourceId

string · required

String ID of the affected resource

timestamp

string · date-time · required

ISO 8601 timestamp when the event was emitted

apiVersion

string · enum · required

Enum values:

object · required

Webhook: Article published › Responses

200

Acknowledged. Karma considers any 2xx response a successful delivery; non-2xx triggers retry with exponential backoff.

No data returned

POST/webhook/article.published

curl --request POST \
  --url https://common-api.karma.life/webhook/article.published \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "evt_01HZK3...",
  "event": "article.published",
  "resource": "article",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "title": "title",
    "content": {},
    "authorRetailerUserId": 0,
    "tags": [
      "string"
    ],
    "status": "DRAFT",
    "imageUrl": "https://www.example.com/path/to/resource",
    "slackMessage": "slackMessage",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}
'

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "article.published",
  "resource": "article",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "title": "title",
    "content": {},
    "authorRetailerUserId": 0,
    "tags": [
      "string"
    ],
    "status": "DRAFT",
    "imageUrl": "https://www.example.com/path/to/resource",
    "slackMessage": "slackMessage",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}

json

Example Responses

No example specified for this content type

Custom Loyalty Provider Cost Centers

Webhook: Article created

POST

https://common-api.karma.life

/webhook/article.created

Fired when a new article is created. The full Article object is spread into data.

Webhook: Article created › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

article.created

resource

string · enum · required

Enum values:

article

resourceId

string · required

String ID of the affected resource

timestamp

string · date-time · required

ISO 8601 timestamp when the event was emitted

apiVersion

string · enum · required

Enum values:

object · required

Webhook: Article created › Responses

200

Acknowledged. Karma considers any 2xx response a successful delivery; non-2xx triggers retry with exponential backoff.

No data returned

Webhook: Article updated

POST

https://common-api.karma.life

/webhook/article.updated

Only the modified fields appear in changes.

Webhook: Article updated › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

article.updated

resource

string · enum · required

Enum values:

article

resourceId

string · required

String ID of the affected resource

timestamp

string · date-time · required

ISO 8601 timestamp when the event was emitted

apiVersion

string · enum · required

Enum values:

object

Webhook: Article updated › Responses

200

Acknowledged. Karma considers any 2xx response a successful delivery; non-2xx triggers retry with exponential backoff.

No data returned

Webhook: Article deleted

POST

https://common-api.karma.life

/webhook/article.deleted

Soft delete.

Webhook: Article deleted › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

article.deleted

resource

string · enum · required

Enum values:

article

resourceId

string · required

String ID of the affected resource

timestamp

string · date-time · required

ISO 8601 timestamp when the event was emitted

apiVersion

string · enum · required

Enum values:

object

Webhook: Article deleted › Responses

200

Acknowledged. Karma considers any 2xx response a successful delivery; non-2xx triggers retry with exponential backoff.

No data returned

Webhook: Article published

POST

https://common-api.karma.life

/webhook/article.published

Fired when an article transitions from DRAFT to PUBLISHED. The full Article object is spread into data.

Webhook: Article published › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

article.published

resource

string · enum · required

Enum values:

article

resourceId

string · required

String ID of the affected resource

timestamp

string · date-time · required

ISO 8601 timestamp when the event was emitted

apiVersion

string · enum · required

Enum values:

object · required

Webhook: Article published › Responses

200

Acknowledged. Karma considers any 2xx response a successful delivery; non-2xx triggers retry with exponential backoff.

No data returned