Code Webhooks (Optional)

OnboardList webhooks let you programmatically check or uncheck an item on a specific user's checklist when that user completes an action in your app. They also let you unsubscribe a user from reminder emails if a user closes their account.

  1. To check off a step, send a POST request to https://www.onboardlist.com/api/completion with the following JSON request body:
    
    {
      "stepId": 1,
      "identifier": 1
    }
    
    
    Pass the actual ID of the step as the stepId, and the same unique identifier for the user you passed to the OnboardList.initialize() function in the script for the OnboardList checklist widget.

    To find the ID of a step, go to the Manage Checklist page and under Actions edit the step by clicking on the pencil icon. The last number in the page's web address is the stepId, for example if the URL in your browser is https://www.onboardlist.com/domains/1/step/3 the stepId is 3.
  2. To uncheck a step, send a DELETE request to https://www.onboardlist.com/api/completion with the same request body used to check off a step:
    
    {
        "stepId": 1,
        "identifier": 1
    }
    
    
  3. To unsubscribe a user, send a POST request to https://www.onboardlist.com/api/unsubscribe with the hostname plus the user's email address and unique identifier in the request body:
    
    {
        "hostname": "www.yourdomain.com",
        "email": "john.doe@gmail.com",
        "identifier": 1
    }
    
    

Previous: Install Widget

Next: Optimize Steps