Ason Payroll Integration API v1

Webhooks

Endpointhttps://sandbox-api.asonpayroll.com

Query webhooks

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/webhooks

Query webhooks › path Parameters

tenantId

string · uuid · required

The tenant id

Query webhooks › query Parameters

filter

string

The OData filter expression (with support for attribute fields)

orderBy

string

The OData order-by expression (with support for attribute fields)

result

string · enum

The query result type: items, count or items with count (default: result items)

The query result type

Enum values:

Items

Count

ItemsWithCount

select

string

The OData field selection expression

skip

integer · int64

The number of items in the queried collection that are to be skipped

status

string · enum

The object status (default: all status)

The object status

Enum values:

Active

Inactive

top

integer · int64

The number of items in the queried collection

Query webhooks › Responses

Success

Query result

count

integer · int64

The query result count

array | null

The query result items

Add a new webhook

POST

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/webhooks

Add a new webhook › path Parameters

tenantId

string · uuid · required

The tenant id

Add a new webhook › Request Body

The Webhook API object

payloadUrl

string · uri · minLength: 1 · required

The URL to send the event payload to

object[] · required

The events that trigger the webhook

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

hasSecret

boolean

True if the webhook is configured with a secret

secret

string | null

The secret for the webhook. This property is only used when the client sets a secret.

object | null

The metadata to include in the payload

object | null

Custom attributes

Add a new webhook › Responses

Created

The Webhook API object

payloadUrl

string · uri · minLength: 1 · required

The URL to send the event payload to

object[] · required

The events that trigger the webhook

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

hasSecret

boolean

True if the webhook is configured with a secret

secret

string | null

The secret for the webhook. This property is only used when the client sets a secret.

object | null

The metadata to include in the payload

object | null

Custom attributes

POST/api/tenants/{tenantId}/webhooks

curl --request POST \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/webhooks \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "Active",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "payloadUrl": "https://www.example.com/path/to/resource",
  "events": [
    {
      "$type": "CaseChangeAdded"
    }
  ],
  "hasSecret": true,
  "secret": "secret",
  "payloadMetadata": {
    "key": {}
  },
  "attributes": {
    "key": {}
  }
}
'

shell

Example Request Body

{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "Active",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "payloadUrl": "https://www.example.com/path/to/resource",
  "events": [
    {
      "$type": "CaseChangeAdded"
    }
  ],
  "hasSecret": true,
  "secret": "secret",
  "payloadMetadata": {
    "key": {}
  },
  "attributes": {
    "key": {}
  }
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "Active",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "payloadUrl": "https://www.example.com/path/to/resource",
  "events": [
    {
      "$type": "CaseChangeAdded"
    }
  ],
  "hasSecret": true,
  "secret": "secret",
  "payloadMetadata": {
    "key": {}
  },
  "attributes": {
    "key": {}
  }
}

json

application/json

Get a webhook

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/webhooks/{webhookId}

Get a webhook › path Parameters

tenantId

string · uuid · required

The tenant id

webhookId

string · uuid · required

The id of the webhook

Get a webhook › Responses

Success

The Webhook API object

payloadUrl

string · uri · minLength: 1 · required

The URL to send the event payload to

object[] · required

The events that trigger the webhook

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

hasSecret

boolean

True if the webhook is configured with a secret

secret

string | null

The secret for the webhook. This property is only used when the client sets a secret.

object | null

The metadata to include in the payload

object | null

Custom attributes

Update a webhook

PUT

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/webhooks/{webhookId}

Update a webhook › path Parameters

tenantId

string · uuid · required

The tenant id

webhookId

string · required

Update a webhook › Request Body

The Webhook API object

payloadUrl

string · uri · minLength: 1 · required

The URL to send the event payload to

object[] · required

The events that trigger the webhook

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

hasSecret

boolean

True if the webhook is configured with a secret

secret

string | null

The secret for the webhook. This property is only used when the client sets a secret.

object | null

The metadata to include in the payload

object | null

Custom attributes

Update a webhook › Responses

Success

The Webhook API object

payloadUrl

string · uri · minLength: 1 · required

The URL to send the event payload to

object[] · required

The events that trigger the webhook

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

hasSecret

boolean

True if the webhook is configured with a secret

secret

string | null

The secret for the webhook. This property is only used when the client sets a secret.

object | null

The metadata to include in the payload

object | null

Custom attributes

PUT/api/tenants/{tenantId}/webhooks/{webhookId}

curl --request PUT \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/webhooks/:webhookId \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "Active",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "payloadUrl": "https://www.example.com/path/to/resource",
  "events": [
    {
      "$type": "CaseChangeAdded"
    }
  ],
  "hasSecret": true,
  "secret": "secret",
  "payloadMetadata": {
    "key": {}
  },
  "attributes": {
    "key": {}
  }
}
'

shell

Example Request Body

{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "Active",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "payloadUrl": "https://www.example.com/path/to/resource",
  "events": [
    {
      "$type": "CaseChangeAdded"
    }
  ],
  "hasSecret": true,
  "secret": "secret",
  "payloadMetadata": {
    "key": {}
  },
  "attributes": {
    "key": {}
  }
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "Active",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "payloadUrl": "https://www.example.com/path/to/resource",
  "events": [
    {
      "$type": "CaseChangeAdded"
    }
  ],
  "hasSecret": true,
  "secret": "secret",
  "payloadMetadata": {
    "key": {}
  },
  "attributes": {
    "key": {}
  }
}

json

application/json

Delete a webhook

DELETE

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/webhooks/{webhookId}

Delete a webhook › path Parameters

tenantId

string · uuid · required

The tenant id

webhookId

string · uuid · required

The id of the webhook

Delete a webhook › Responses

200

Success

No data returned

Query the messages the webhook has produced

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/webhooks/{webhookId}/messages

Query the messages the webhook has produced › path Parameters

tenantId

string · uuid · required

The tenant id

webhookId

string · uuid · required

The web hook id

Query the messages the webhook has produced › query Parameters

filter

string

The OData filter expression (with support for attribute fields)

orderBy

string

The OData order-by expression (with support for attribute fields)

result

string · enum

The query result type: items, count or items with count (default: result items)

The query result type

Enum values:

Items

Count

ItemsWithCount

select

string

The OData field selection expression

skip

integer · int64

The number of items in the queried collection that are to be skipped

status

string · enum

The object status (default: all status)

The object status

Enum values:

Active

Inactive

top

integer · int64

The number of items in the queried collection

Query the messages the webhook has produced › Responses

Success

Query result

count

integer · int64

The query result count

array | null

The query result items

Employee case values Users

Query webhooks

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/webhooks

Query webhooks › path Parameters

tenantId

string · uuid · required

The tenant id

Query webhooks › query Parameters

filter

string

The OData filter expression (with support for attribute fields)

orderBy

string

The OData order-by expression (with support for attribute fields)

result

string · enum

The query result type: items, count or items with count (default: result items)

The query result type

Enum values:

Items

Count

ItemsWithCount

select

string

The OData field selection expression

skip

integer · int64

The number of items in the queried collection that are to be skipped

status

string · enum

The object status (default: all status)

The object status

Enum values:

Active

Inactive

top

integer · int64

The number of items in the queried collection

Query webhooks › Responses

Success

Query result

count

integer · int64

The query result count

array | null

The query result items

Add a new webhook

POST

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/webhooks

Add a new webhook › path Parameters

tenantId

string · uuid · required

The tenant id

Add a new webhook › Request Body

The Webhook API object

payloadUrl

string · uri · minLength: 1 · required

The URL to send the event payload to

object[] · required

The events that trigger the webhook

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

hasSecret

boolean

True if the webhook is configured with a secret

secret

string | null

The secret for the webhook. This property is only used when the client sets a secret.

object | null

The metadata to include in the payload

object | null

Custom attributes

Add a new webhook › Responses

Created

The Webhook API object

payloadUrl

string · uri · minLength: 1 · required

The URL to send the event payload to

object[] · required

The events that trigger the webhook

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

hasSecret

boolean

True if the webhook is configured with a secret

secret

string | null

The secret for the webhook. This property is only used when the client sets a secret.

object | null

The metadata to include in the payload

object | null

Custom attributes

Get a webhook

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/webhooks/{webhookId}

Get a webhook › path Parameters

tenantId

string · uuid · required

The tenant id

webhookId

string · uuid · required

The id of the webhook

Get a webhook › Responses

Success

The Webhook API object

payloadUrl

string · uri · minLength: 1 · required

The URL to send the event payload to

object[] · required

The events that trigger the webhook

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

hasSecret

boolean

True if the webhook is configured with a secret

secret

string | null

The secret for the webhook. This property is only used when the client sets a secret.

object | null

The metadata to include in the payload

object | null

Custom attributes

Update a webhook

PUT

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/webhooks/{webhookId}

Update a webhook › path Parameters

tenantId

string · uuid · required

The tenant id

webhookId

string · required

Update a webhook › Request Body

The Webhook API object

payloadUrl

string · uri · minLength: 1 · required

The URL to send the event payload to

object[] · required

The events that trigger the webhook

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

hasSecret

boolean

True if the webhook is configured with a secret

secret

string | null

The secret for the webhook. This property is only used when the client sets a secret.

object | null

The metadata to include in the payload

object | null

Custom attributes

Update a webhook › Responses

Success

The Webhook API object

payloadUrl

string · uri · minLength: 1 · required

The URL to send the event payload to

object[] · required

The events that trigger the webhook

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

hasSecret

boolean

True if the webhook is configured with a secret

secret

string | null

The secret for the webhook. This property is only used when the client sets a secret.

object | null

The metadata to include in the payload

object | null

Custom attributes

Query the messages the webhook has produced

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/webhooks/{webhookId}/messages

Query the messages the webhook has produced › path Parameters

tenantId

string · uuid · required

The tenant id

webhookId

string · uuid · required

The web hook id

Query the messages the webhook has produced › query Parameters

filter

string

The OData filter expression (with support for attribute fields)

orderBy

string

The OData order-by expression (with support for attribute fields)

result

string · enum

The query result type: items, count or items with count (default: result items)

The query result type

Enum values:

Items

Count

ItemsWithCount

select

string

The OData field selection expression

skip

integer · int64

The number of items in the queried collection that are to be skipped

status

string · enum

The object status (default: all status)

The object status

Enum values:

Active

Inactive

top

integer · int64

The number of items in the queried collection

Query the messages the webhook has produced › Responses

Success

Query result

count

integer · int64

The query result count

array | null

The query result items