Web Hooks

get

List all current web hooks.

Authorizations

Path parameters

station_idany ofRequired

integer · int64Optional

or

string · stringOptional

Responses

200

Success

application/json

Responseall of[]

403

Access denied.

application/json

404

Record not found.

application/json

500

A generic exception has occurred.

application/json

get

HTTPcURLJavaScriptPython

GET /api/station/{station_id}/webhooks HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Accept: */*

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

post

Create a new web hook.

Authorizations

Path parameters

station_idany ofRequired

integer · int64Optional

or

string · stringOptional

Body

all ofOptional

Responses

200

Success

application/json

Responseall of

403

Access denied.

application/json

404

Record not found.

application/json

500

A generic exception has occurred.

application/json

post

HTTPcURLJavaScriptPython

POST /api/station/{station_id}/webhooks HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 105

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

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

get

Retrieve details for a single web hook.

Authorizations

Path parameters

station_idany ofRequired

integer · int64Optional

or

string · stringOptional

idinteger · int64Required

Web Hook ID

Responses

200

Success

application/json

Responseall of

403

Access denied.

application/json

404

Record not found.

application/json

500

A generic exception has occurred.

application/json

get

HTTPcURLJavaScriptPython

GET /api/station/{station_id}/webhook/{id} HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Accept: */*

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

put

Update details of a single web hook.

Authorizations

Path parameters

station_idany ofRequired

integer · int64Optional

or

string · stringOptional

idinteger · int64Required

Web Hook ID

Body

all ofOptional

Responses

200

Success

application/json

403

Access denied.

application/json

404

Record not found.

application/json

500

A generic exception has occurred.

application/json

put

HTTPcURLJavaScriptPython

PUT /api/station/{station_id}/webhook/{id} HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 105

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

{
  "success": true,
  "message": "Changes saved successfully.",
  "formatted_message": "<b>Changes saved successfully.</b>"
}

delete

Delete a single web hook relay.

Authorizations

Path parameters

station_idany ofRequired

integer · int64Optional

or

string · stringOptional

idinteger · int64Required

Web Hook ID

Responses

200

Success

application/json

403

Access denied.

application/json

404

Record not found.

application/json

500

A generic exception has occurred.

application/json

delete

HTTPcURLJavaScriptPython

DELETE /api/station/{station_id}/webhook/{id} HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "message": "Changes saved successfully.",
  "formatted_message": "<b>Changes saved successfully.</b>"
}