Create a new web hook.

POST

https://demo.azuracast.com/api/station/{station_id}/webhooks

curl -X POST 'https://demo.azuracast.com/api/station/0/webhooks' \
  -H 'X-API-Key: YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "name": "Twitter Post",
  "type": "generic",
  "is_enabled": true,
  "triggers": [],
  "config": [],
  "metadata": []
}'

const body = `{
  "name": "Twitter Post",
  "type": "generic",
  "is_enabled": true,
  "triggers": [],
  "config": [],
  "metadata": []
}`;

const response = await fetch('https://demo.azuracast.com/api/station/0/webhooks', {
  method: 'POST',
  headers: {
    'X-API-Key': 'YOUR_TOKEN',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "name": "Twitter Post",
  "type": "generic",
  "is_enabled": true,
  "triggers": [],
  "config": [],
  "metadata": []
}'''

response = requests.post(
    'https://demo.azuracast.com/api/station/0/webhooks',
    data=body.encode('utf-8'),
    headers={
        'X-API-Key': 'YOUR_TOKEN',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "name": "Twitter Post",
  "type": "generic",
  "is_enabled": true,
  "triggers": [],
  "config": [],
  "metadata": []
}

{
  "id": 0,
  "name": "Twitter Post",
  "type": "generic",
  "is_enabled": true,
  "triggers": [],
  "config": [],
  "metadata": []
}

{
  "code": 500,
  "type": "NotLoggedInException",
  "message": "Error description.",
  "formatted_message": "<b>Error description.</b><br>Detailed error text.",
  "extra_data": [],
  "success": false
}

{
  "code": 500,
  "type": "NotLoggedInException",
  "message": "Error description.",
  "formatted_message": "<b>Error description.</b><br>Detailed error text.",
  "extra_data": [],
  "success": false
}

{
  "code": 500,
  "type": "NotLoggedInException",
  "message": "Error description.",
  "formatted_message": "<b>Error description.</b><br>Detailed error text.",
  "extra_data": [],
  "success": false
}

Body

application/json

namestring | null

The nickname of the webhook connector.

Example

Twitter Post

typeWebhookTypesgenericemailtuneinradioderadioreggetmeradiodiscordtelegramgroupmemastodonblueskygoogle_analytics_v4matomo_analyticstwittergoogle_analytics

is_enabledboolean

Example

true

triggersArray<any>

List of events that should trigger the webhook notification.

configArray<any>

Detailed webhook configuration (if applicable)

metadataArray<any>

Internal details used by the webhook to preserve state.

Parameters

station_idinteger | stringrequiredpath

Response

200OKHasAutoIncrementId & object

Success

Response fields application/json

idintegerrequiredread only

namestring | null

The nickname of the webhook connector.

Example

Twitter Post

typeWebhookTypesgenericemailtuneinradioderadioreggetmeradiodiscordtelegramgroupmemastodonblueskygoogle_analytics_v4matomo_analyticstwittergoogle_analytics

is_enabledboolean

Example

true

triggersArray<any>

List of events that should trigger the webhook notification.

configArray<any>

Detailed webhook configuration (if applicable)

metadataArray<any>

Internal details used by the webhook to preserve state.

403ForbiddenApi_Error

Access denied.

Response fields application/json

codeintegerrequired

The numeric code of the error.

Example

typestringrequired

The programmatic class of error.

Example

NotLoggedInException

messagestringrequired

The text description of the error.

Example

Error description.

formatted_messagestring | nullrequired

The HTML-formatted text description of the error.

Example

<b>Error description.</b><br>Detailed error text.

extra_dataArray<any>required

Stack traces and other supplemental data.

successbooleanrequired

Used for API calls that expect an \Entity\Api\Status type response.

Example

false

404Not FoundApi_Error

Record not found.

Response fields application/json

codeintegerrequired

The numeric code of the error.

Example

typestringrequired

The programmatic class of error.

Example

NotLoggedInException

messagestringrequired

The text description of the error.

Example

Error description.

formatted_messagestring | nullrequired

The HTML-formatted text description of the error.

Example

<b>Error description.</b><br>Detailed error text.

extra_dataArray<any>required

Stack traces and other supplemental data.

successbooleanrequired

Used for API calls that expect an \Entity\Api\Status type response.

Example

false

500Internal Server ErrorApi_Error

A generic exception has occurred.

Response fields application/json

codeintegerrequired

The numeric code of the error.

Example

typestringrequired

The programmatic class of error.

Example

NotLoggedInException

messagestringrequired

The text description of the error.

Example

Error description.

formatted_messagestring | nullrequired

The HTML-formatted text description of the error.

Example

<b>Error description.</b><br>Detailed error text.

extra_dataArray<any>required

Stack traces and other supplemental data.

successbooleanrequired

Used for API calls that expect an \Entity\Api\Status type response.

Example

false

Authorization

ApiKeyapiKey in header

Docs by Sourcey