Webhook authentication

Basic Authentication is required for most REST API calls.

Create post request to users/login to generate an access key.

POST /users/login returns { user, key }
success - 201
error - 400
{
    "email": "[email protected]",
    "password": "[email protected]"
}

Set the auth header in your request

Then include the access key in your header.

method: 'POST'
{
    uri: 'https://{{your-builderly-domain}}/webhook-auth',
    headers: {
        'Authorization': 'Bearer ' + token
    },
    json: true,
    body: {}
}

Responses Success - status 201

{ api_token }

Error - status 400

{ error_message }

Set the X-API-KEY header in your requests

Then include the api token in your header.

method: 'ANY'
{
    uri: 'https://{{your-builderly-domain}}/webhook/{{action}}',
    headers: {
        'X-API-KEY': api_token
    },
    json: true,
    body: {}
}

Keep in mind, this endpoint requires admin privileges which can be set inside Builderly's admin dashboard.