Back to Provider Endpoints
POST /v1/providers
Create a new provider. The auth_value is only shown once in the response.
Request
http
POST https://api.votepipe.com/v1/providers
Authorization: Bearer mr_live_your_api_key_here
Content-Type: application/json
{
"key": "mylist",
"name": "My Server List",
"auth_method": "query",
"auth_field": "token",
"auth_value": "auto",
"votee_path": "username"
}Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| key | string | Yes | Unique provider key (used in webhook URL) |
| name | string | Yes | Display name |
| auth_method | string | Yes | One of: header, url_path, query, hmac |
| auth_field | string | Yes | Field name for authentication |
| auth_value | string | No | Secret value (use "auto" to generate) |
| votee_path | string | Yes | JSON path to voter name (e.g., "voter.username") |
Response (201 Created)
json
{
"data": {
"id": "2",
"key": "mylist",
"name": "My Server List",
"auth_value": "generated_secret_here",
"webhook_url": "https://hooks.votepipe.com/my-server/mylist?token=generated_secret_here"
},
"meta": {
"request_id": "req_abc123"
}
}⚠️ The auth_value is only shown once! Save it immediately.