{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Payroll Integration Guide"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"payroll-integration-guide","__idx":0},"children":["Payroll Integration Guide"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"overview","__idx":1},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Partners will send lightweight event notifications to a Basic Capital webhook when key events occur in their systems. We will provision a specific webhook url for you."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"sample-webhook-url","__idx":2},"children":["Sample Webhook URL"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Testing\nhttps://api.basiccapital.dev/v1/{your_payroll_system}\n\nProduction\nhttps://api.basiccapital.com/v1/{your_payroll_system}\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"event-endpoints","__idx":3},"children":["Event Endpoints"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These are events you will send to the webhook endpoint we will provision for you."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"1-employment-events","__idx":4},"children":["1. Employment Events"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["POST"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/employment/event"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Send this event when an employee is hired, terminated, or updated (e.g., compensation changes)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request Body:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"event_id\": \"evt_1a2b3c4d5e6f\",\n  \"employer_id\": \"emp_9z8y7x6w5v4u\",\n  \"employee_id\": \"ee_7k6j5h4g3f2d\",\n  \"event_type\": \"EMPLOYEE_HIRED\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Event Types:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EMPLOYEE_HIRED"]}," - New employee started"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EMPLOYEE_UPDATED"]}," - Employee information changed (compensation, role, etc.)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EMPLOYEE_TERMINATED"]}," - Employee left the company"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["202 Accepted"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"2-employer-events","__idx":5},"children":["2. Employer Events"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["POST"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/employer/event"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Send this event when an employer is updated or company-wide deductions are changed."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request Body:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"event_id\": \"evt_4d5e6f7g8h9i\",\n  \"employer_id\": \"emp_9z8y7x6w5v4u\",\n  \"event_type\": \"EMPLOYER_UPDATED\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Event Types:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EMPLOYER_UPDATED"]}," - Employer information or company-wide deductions changed"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["202 Accepted"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"3-payroll-events","__idx":6},"children":["3. Payroll Events"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["POST"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/payroll/event"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Send this event when payroll is processed and paid."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request Body:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"event_id\": \"evt_5e6f7g8h9i0j\",\n  \"employer_id\": \"emp_9z8y7x6w5v4u\",\n  \"payroll_event_id\": \"prl_3m2n1b0v9c8x\",\n  \"event_type\": \"PAYROLL_PAID\",\n  \"pay_date\":\"YYYY-MM-DD\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Event Types:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PAYROLL_PAID"]}," - Payroll has been processed and paid"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["202 Accepted"]}]}]},"headings":[{"value":"Payroll Integration Guide","id":"payroll-integration-guide","depth":1},{"value":"Overview","id":"overview","depth":2},{"value":"Sample Webhook URL","id":"sample-webhook-url","depth":3},{"value":"Event Endpoints","id":"event-endpoints","depth":3},{"value":"1. Employment Events","id":"1-employment-events","depth":4},{"value":"2. Employer Events","id":"2-employer-events","depth":4},{"value":"3. Payroll Events","id":"3-payroll-events","depth":4}],"frontmatter":{"title":"Basic Capital Payroll Integration Guide","seo":{"title":"Payroll Integration Guide"}},"lastModified":"2026-09-14T19:48:02.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/rest/payroll","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}