Lumar offers an API callback feature (also known as a webhook) that helps facilitate building integrations with our API.

By inputting a URL into the API callback field, Lumar will make a POST request to this URL whenever any crawl in your account has been completed in order to trigger an external application. In the POST request Lumar will include the following payload.

{  
message: 'crawl_status', 
resource: 'crawl', 
crawl_id: 124234, 
project_id: 1123123,
account_id: 123123,
user_id: 123123,
partner_user_id: 3333312, // if SSO
partner_account_id: 123123, // if SSO
status: "finished",
href: "/accounts/123123/projects/1123123/crawls/124234"
}

Set up for all projects in your account

To setup the API callback on the account level, navigate to the API Access page from the dropdown menu in the top right corner of the screen.

Set up for a specific project in your account

To setup the API callback for a specific project navigate to the project edit screen for a specific project. Then head to step 4 and click on Advanced Settings. The API Callback feature can be found at the towards the bottom of the Advanced Settings.