Heartwork API

Webhooks

Endpointhttps://api.heart.work

Download schema

Fetches a collection of webhooks.

GET

https://api.heart.work

/core-api/webhooks

Fetches a collection of webhooks. › query Parameters

Take

integer · int32

Skip

integer · int32

SortOrder

string · enum

Enum values:

Asc

Desc

SortBy

string · enum

Enum values:

Name

Query

string

Fetches a collection of webhooks. › Responses

object[] · required

total

integer · int32 · required

GET/core-api/webhooks

curl --request GET \
  --url https://api.heart.work/core-api/webhooks

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "name": "name",
      "topicName": "topicName",
      "deliveryEndpoint": "deliveryEndpoint",
      "skipSystem": true,
      "headers": {},
      "enabled": true
    }
  ],
  "total": 0
}

plain

POST

https://api.heart.work

/core-api/webhooks

Request Body

name

string · required

topicName

string · required

deliveryEndpoint

string · required

skipSystem

boolean · required

enabled

boolean · required

object

Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

topicName

string · required

deliveryEndpoint

string · required

skipSystem

boolean · required

object · required

enabled

boolean · required

externalReference

string

POST/core-api/webhooks

curl --request POST \
  --url https://api.heart.work/core-api/webhooks \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "topicName": "topicName",
  "deliveryEndpoint": "deliveryEndpoint",
  "skipSystem": true,
  "headers": {},
  "enabled": true
}
'

shell

Example Request Body

{
  "name": "name",
  "topicName": "topicName",
  "deliveryEndpoint": "deliveryEndpoint",
  "skipSystem": true,
  "headers": {},
  "enabled": true
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "name": "name",
  "topicName": "topicName",
  "deliveryEndpoint": "deliveryEndpoint",
  "skipSystem": true,
  "headers": {},
  "enabled": true
}

plain

GET

https://api.heart.work

/core-api/webhooks/{id}

path Parameters

id

string · required

Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

topicName

string · required

deliveryEndpoint

string · required

skipSystem

boolean · required

object · required

enabled

boolean · required

externalReference

string

GET/core-api/webhooks/{id}

curl --request GET \
  --url https://api.heart.work/core-api/webhooks/:id

shell

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "name": "name",
  "topicName": "topicName",
  "deliveryEndpoint": "deliveryEndpoint",
  "skipSystem": true,
  "headers": {},
  "enabled": true
}

plain

PUT

https://api.heart.work

/core-api/webhooks/{id}

path Parameters

id

string · required

Request Body

name

string · required

topicName

string · required

deliveryEndpoint

string · required

skipSystem

boolean · required

enabled

boolean · required

id

string · required

object

Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

topicName

string · required

deliveryEndpoint

string · required

skipSystem

boolean · required

object · required

enabled

boolean · required

externalReference

string

PUT/core-api/webhooks/{id}

curl --request PUT \
  --url https://api.heart.work/core-api/webhooks/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "topicName": "topicName",
  "deliveryEndpoint": "deliveryEndpoint",
  "skipSystem": true,
  "headers": {},
  "enabled": true,
  "id": "id"
}
'

shell

Example Request Body

{
  "name": "name",
  "topicName": "topicName",
  "deliveryEndpoint": "deliveryEndpoint",
  "skipSystem": true,
  "headers": {},
  "enabled": true,
  "id": "id"
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "name": "name",
  "topicName": "topicName",
  "deliveryEndpoint": "deliveryEndpoint",
  "skipSystem": true,
  "headers": {},
  "enabled": true
}

plain

DELETE

https://api.heart.work

/core-api/webhooks/{id}

path Parameters

id

string · required

Responses

No data returned

DELETE/core-api/webhooks/{id}

curl --request DELETE \
  --url https://api.heart.work/core-api/webhooks/:id

shell

Example Responses

No example specified for this content type

GET

https://api.heart.work

/core-api/webhooks/topics

Responses

object[] · required

total

integer · int32 · required

GET/core-api/webhooks/topics

curl --request GET \
  --url https://api.heart.work/core-api/webhooks/topics

shell

Example Responses

{
  "data": [
    {
      "name": "name",
      "displayName": "displayName",
      "type": "Read"
    }
  ],
  "total": 0
}

plain

VatCodes Workspaces

Heartwork API

Webhooks

Endpointhttps://api.heart.work

Download schema

Fetches a collection of webhooks.

GET

https://api.heart.work

/core-api/webhooks

Fetches a collection of webhooks. › query Parameters

Take

integer · int32

Skip

integer · int32

SortOrder

string · enum

Enum values:

Asc

Desc

SortBy

string · enum

Enum values:

Name

Query

string

Fetches a collection of webhooks. › Responses

object[] · required

total

integer · int32 · required

GET/core-api/webhooks

curl --request GET \
  --url https://api.heart.work/core-api/webhooks

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "name": "name",
      "topicName": "topicName",
      "deliveryEndpoint": "deliveryEndpoint",
      "skipSystem": true,
      "headers": {},
      "enabled": true
    }
  ],
  "total": 0
}

plain

POST

https://api.heart.work

/core-api/webhooks

Request Body

name

string · required

topicName

string · required

deliveryEndpoint

string · required

skipSystem

boolean · required

enabled

boolean · required

object

Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

topicName

string · required

deliveryEndpoint

string · required

skipSystem

boolean · required

object · required

enabled

boolean · required

externalReference

string

POST/core-api/webhooks

curl --request POST \
  --url https://api.heart.work/core-api/webhooks \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "topicName": "topicName",
  "deliveryEndpoint": "deliveryEndpoint",
  "skipSystem": true,
  "headers": {},
  "enabled": true
}
'

shell

Example Request Body

{
  "name": "name",
  "topicName": "topicName",
  "deliveryEndpoint": "deliveryEndpoint",
  "skipSystem": true,
  "headers": {},
  "enabled": true
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "name": "name",
  "topicName": "topicName",
  "deliveryEndpoint": "deliveryEndpoint",
  "skipSystem": true,
  "headers": {},
  "enabled": true
}

plain

GET

https://api.heart.work

/core-api/webhooks/{id}

path Parameters

id

string · required

Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

topicName

string · required

deliveryEndpoint

string · required

skipSystem

boolean · required

object · required

enabled

boolean · required

externalReference

string

GET/core-api/webhooks/{id}

curl --request GET \
  --url https://api.heart.work/core-api/webhooks/:id

shell

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "name": "name",
  "topicName": "topicName",
  "deliveryEndpoint": "deliveryEndpoint",
  "skipSystem": true,
  "headers": {},
  "enabled": true
}

plain

PUT

https://api.heart.work

/core-api/webhooks/{id}

path Parameters

id

string · required

Request Body

name

string · required

topicName

string · required

deliveryEndpoint

string · required

skipSystem

boolean · required

enabled

boolean · required

id

string · required

object

Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

topicName

string · required

deliveryEndpoint

string · required

skipSystem

boolean · required

object · required

enabled

boolean · required

externalReference

string

PUT/core-api/webhooks/{id}

curl --request PUT \
  --url https://api.heart.work/core-api/webhooks/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "topicName": "topicName",
  "deliveryEndpoint": "deliveryEndpoint",
  "skipSystem": true,
  "headers": {},
  "enabled": true,
  "id": "id"
}
'

shell

Example Request Body

{
  "name": "name",
  "topicName": "topicName",
  "deliveryEndpoint": "deliveryEndpoint",
  "skipSystem": true,
  "headers": {},
  "enabled": true,
  "id": "id"
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "name": "name",
  "topicName": "topicName",
  "deliveryEndpoint": "deliveryEndpoint",
  "skipSystem": true,
  "headers": {},
  "enabled": true
}

plain

DELETE

https://api.heart.work

/core-api/webhooks/{id}

path Parameters

id

string · required

Responses

No data returned

DELETE/core-api/webhooks/{id}

curl --request DELETE \
  --url https://api.heart.work/core-api/webhooks/:id

shell

Example Responses

No example specified for this content type

GET

https://api.heart.work

/core-api/webhooks/topics

Responses

object[] · required

total

integer · int32 · required

GET/core-api/webhooks/topics

curl --request GET \
  --url https://api.heart.work/core-api/webhooks/topics

shell

Example Responses

{
  "data": [
    {
      "name": "name",
      "displayName": "displayName",
      "type": "Read"
    }
  ],
  "total": 0
}

plain

VatCodes Workspaces