List all current web hooks.

GET

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

curl -X GET 'https://demo.azuracast.com/api/station/0/webhooks' \
  -H 'X-API-Key: YOUR_TOKEN'

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

const data = await response.text();

import requests

response = requests.get(
    'https://demo.azuracast.com/api/station/0/webhooks',
    headers={
        'X-API-Key': 'YOUR_TOKEN',
    },
)
print(response.text)

[
  {
    "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
}

Parameters

station_idinteger | stringrequiredpath

Response

200OKArray<StationWebhook>

Success

Response fields application/json

Array<StationWebhook>

Show child attributes

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