API Reference

Webhooks - Registration Requests

Webhooks let your application receive real-time updates about Registration Requests created via the Create Registration Request endpoint.

How it works

  1. You register an HTTPS endpoint that accepts POST requests.
  2. We send you events as JSON whenever something changes.
  3. You return 200 OK to acknowledge receipt.

Subscribe to events

You can subscribe to the following event types:

  • registration_request.submitted
    Sent when a state tax Registration Request (created via Create Registration Request) is submitted by the employer.
  • registration_request.updated
    Sent when a Tax Registration Item created by that submitted Registration Request is completed and its Tax IDs are available. Multiple updates are possible as items complete over time.

Example Payloads:

{
  "account_id": "your-middesk-account-id",
  "created_at": "2023-02-08T18:04:43.939Z",
  "data" : {
    "object": {
      "object": "registration_request",
      "id": "middesk-registration-request-id",
      "state": "CA",
      "company_id": "middesk-child-company-id",
      "created_at": "2023-02-02T17:00:22Z",
      "submitted_at": "2023-02-08T18:04:43Z",
      "status": "submitted",
      "items": [
        {
          "agency": "Employment Development Department (EDD)",
          "label": "SUI Rate",
          "state": "CA",
          "updated_at": "2023-02-08T18:04:43Z",
          "value": null
        },
        {
           "agency": "Employment Development Department (EDD)",
           "label": "EDD number",
           "state": "CA",
           "updated_at": "2023-02-08T18:04:43Z",
           "value": null
        }
      ]
    }
  },
  "id": "middesk-event-id",
  "object": "event",
  "type": "registration_request.submitted"
}

{
  "account_id": "your-middesk-account-id",
  "created_at": "2023-02-08T18:04:43.939Z",
  "data" : {
    "object": {
      "object": "registration_request",
      "id": "middesk-registration-request-id",
      "state": "CA",
      "company_id": "middesk-child-company-id",
      "created_at": "2023-02-02T17:00:22Z",
      "submitted_at": "2023-02-08T17:00:43Z",
      "status": "completed",
      "items": [
        {
          "agency": "Employment Development Department (EDD)",
          "label": "SUI Rate",
          "state": "CA",
          "updated_at": "2023-02-08T18:04:43Z",
          "value": "12"
        },
        {
           "agency": "Employment Development Department (EDD)",
           "label": "EDD number",
           "state": "CA",
           "updated_at": "2023-02-08T17:00:43Z",
           "value": "10201"
        }
      ]
    }
  },
  "id": "middesk-event-id",
  "object": "event",
  "type": "registration_request.updated"
}

Registration Request 'status'

Status
pendingRegistration Request has not yet been submitted by employer
submittedRegistration Request has been submitted but not all Tax Registration Items are completed
completedRegistration Request has been submitted and all Tax Registration Items are marked as completed