Skip to main content
POST
/
webhooks
Create a webhook
curl --request POST \
  --url https://sandbox.nmbr.co/services/payroll/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "http://localhost/webhooks",
  "is_enabled": true,
  "events": [
    "resource_created",
    "resource_updated",
    "resource_deleted",
    "payroll_approved",
    "payroll_unapproved",
    "payroll_paid",
    "payroll_deadline_upcoming",
    "pay_stub_available",
    "async_task_completed",
    "form_batch_completed",
    "integration_authentication_success",
    "integration_authentication_failure",
    "integration_sync_account_codes_complete",
    "integration_sync_account_codes_failure",
    "integration_sync_journal_entries_complete",
    "integration_sync_journal_entries_failure",
    "integration_sync_tags_complete",
    "integration_sync_tags_failure"
  ]
}
'
{
  "id": "<id>",
  "object": "webhook",
  "data": {
    "url": "http://localhost/webhooks",
    "key": "<token>",
    "is_enabled": true,
    "events": [
      "resource_created",
      "resource_updated",
      "resource_deleted",
      "payroll_approved",
      "payroll_unapproved",
      "payroll_paid",
      "payroll_deadline_upcoming",
      "pay_stub_available",
      "async_task_completed",
      "form_batch_completed",
      "integration_authentication_success",
      "integration_authentication_failure",
      "integration_sync_account_codes_complete",
      "integration_sync_account_codes_failure",
      "integration_sync_journal_entries_complete",
      "integration_sync_journal_entries_failure",
      "integration_sync_tags_complete",
      "integration_sync_tags_failure"
    ],
    "created_at": "2026-01-01T00:00:00.000000Z",
    "updated_at": "2026-01-01T00:00:00.000000Z"
  },
  "links": {
    "self": "/webhooks/<id>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
url
string
required
​
is_enabled
boolean
​
events
enum<string>[]
Available options:
async_task_completed,
form_batch_completed,
integration_authentication_failure,
integration_authentication_success,
integration_sync_account_codes_complete,
integration_sync_account_codes_failure,
integration_sync_journal_entries_complete,
integration_sync_journal_entries_failure,
integration_sync_tags_complete,
integration_sync_tags_failure,
pay_stub_available,
payroll_approved,
payroll_deadline_upcoming,
payroll_paid,
payroll_unapproved,
ping,
resource_created,
resource_deleted,
resource_updated

Response

201 - application/json

Created

​
id
string
read-only

The unique identifier of the object in Nmbr.

​
object
string
read-only

The type of the object in Nmbr ("webhook").

​
data
Webhook · object