The documentation for the KFactors Zapier application

Base URL: https://app.kfactors.org:8443

Zapier Endpoint

Log In

GET /zapier/log_in

Required headers:

• “X-EMAIL”: User email address
• “X-API-KEY”: User API key

Response for successful log in:

{
    “status”: “OK”,
    “message”: “Successfully logged in.”,
}

No response for failed log in.

Subscribe hook URL

POST /zapier/rest_hooks/subscribe

Required headers:

• “X-EMAIL”: User email address
• “X-API-KEY”: User API key

Query parameters:

• “inputType”: [’email’, ’emojiFeedbackType’, ‘scoreFeedbackType’]

Response for successful subscription:

{
    “status”: “OK”,
    “message”: “Successfully subscribed hook URL.”,
}

No response for failed subscription.

Unubscribe hook URL

POST /zapier/rest_hooks/unsubscribe

Required headers:

• “X-EMAIL”: User email address
• “X-API-KEY”: User API key

Query parameters:

• “inputType”: [’email’, ’emojiFeedbackType’, ‘scoreFeedbackType’]

Response for successful unsubscription:

{
    “status”: “OK”,
    “message”: “Successfully unsubscribed hook URL.”,
}

Perform list

GET /zapier/performList?conversionType=emails

Required headers:

• “X-EMAIL”: User email address
• “X-API-KEY”: User API key

Query parameters:

• “inputType”: [’email’, ’emojiFeedbackType’, ‘scoreFeedbackType’]

Sample response:

[
    {
        “id”: 1,
        “email”: “[email protected]”,
    },
    {
        “id”: 2,
        “email”: “[email protected]”,
    },
    …
]

Empty array for data.

Users Endpoint

Get user campaigns

GET /campaigns

Required headers:

• “X-EMAIL”: User email address
• “X-API-KEY”: User API key

Sample response:

[
    {
        “id”: 1,
        “campaign_name”: “MyCampagin1”,
    },
    {
        “id”: 2,
        “campaign_name”: “MyCampagin2”,
    },
    …
]

Empty array for no campaigns.