CrowdPower API

The CrowdPower API consists of a public Beacon API and a private Core API.

The Beacon API is used within our JavaScript tag to send data from your website to CrowdPower. It may also be used to send data from your web server. These endpoints use your project's public key for authorization.

The Core API is what the CrowdPower app uses when you are signed into the console. You may ping these endpoints from your web server by authorizing the calls with your project's secret key (or an application key). You should NEVER expose these keys to the outside world.

To authorize your requests, include an Authorization header with a Bearer token. The token will be a public, secret, or application key. You can access your project's keys here: https://app.crowdpower.io/settings/api-keys

📡 Beacon API

AUTHORIZATIONBearer Token

Token

pk_XXXXXXXXXX

POSTIdentify Customer

https://beacon.crowdpower.io/customers

AUTHORIZATIONBearer Token

This request is using Bearer Token from folder📡 Beacon API

HEADERS

Content-Type

application/json

Bodyraw (json)

json

{
    "user_id": "1",
    "email": "billy@crowdpower.io",
    "name": "Billy Madison",
    "phone": "+15555555555",
    "signed_up_at": 1585775554,
    "custom_attributes": {
        "username": "billy"
    }
}

Example Request

curl

curl --location 'https://beacon.crowdpower.io/customers' \
--header 'Content-Type: application/json' \
--data-raw '{
    "user_id": "1",
    "email": "billy@crowdpower.io",
    "name": "Billy Madison",
    "phone": "+15555555555",
    "signed_up_at": 1585775554,
    "custom_attributes": {
        "username": "billy"
    }
}'

Example Response

No response body

This request doesn't return any response body

No response headers

This request doesn't return any response headers

POSTIdentify Customers

https://beacon.crowdpower.io/customers/bulk

AUTHORIZATIONBearer Token

This request is using Bearer Token from folder📡 Beacon API

HEADERS

Content-Type

application/json

Bodyraw (json)

json

{
    "customers": [
        {
            "user_id": "1",
            "email": "billy@crowdpower.io",
            "name": "Billy Madison",
            "phone": "+15555555555",
            "ip": "XXX.XXX.XXX.XX",
            "signed_up_at": 1585775554,
            "custom_attributes": {
                "username": "billy"
            }
        },
        {
            "user_id": "2",
            "email": "happy@crowdpower.io",
            "name": "Happy Gilmore",
            "phone": "+15555555555",
            "ip": "XXX.XXX.XXX.XX",
            "signed_up_at": 1585775554,
            "custom_attributes": {
                "username": "happy"
            }
        }
    ]
}

Example Request

curl

curl --location 'https://beacon.crowdpower.io/customers/bulk' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customers": [
        {
            "user_id": "1",
            "email": "billy@crowdpower.io",
            "name": "Billy Madison",
            "phone": "+15555555555",
            "ip": "XXX.XXX.XXX.XX",
            "signed_up_at": 1585775554,
            "custom_attributes": {
                "username": "billy"
            }
        },
        {
            "user_id": "2",
            "email": "happy@crowdpower.io",
            "name": "Happy Gilmore",
            "phone": "+15555555555",
            "ip": "XXX.XXX.XXX.XX",
            "signed_up_at": 1585775554,
            "custom_attributes": {
                "username": "happy"
            }
        }
    ]
}'

Example Response

No response body

This request doesn't return any response body

No response headers

This request doesn't return any response headers

POSTCreate Event

https://beacon.crowdpower.io/events

AUTHORIZATIONBearer Token

This request is using Bearer Token from folder📡 Beacon API

HEADERS

Content-Type

application/json

Bodyraw (json)

json

{
	"user_id": "1",
	"action": "Signed Up",
	"properties": {
        "method": "Google"
	}
}

Example Request

curl

curl --location 'https://beacon.crowdpower.io/events' \
--header 'Content-Type: application/json' \
--data '{
	"user_id": "1",
	"action": "Signed Up",
	"properties": {
        "method": "Google"
	}
}'

Example Response

No response body

This request doesn't return any response body

No response headers

This request doesn't return any response headers