# \&postapi

General Option! ([`&push`](https://docs.vdo.ninja/advanced-settings/setup-parameters/push), [`&room`](https://docs.vdo.ninja/advanced-settings/setup-parameters/room), [`&view`](https://docs.vdo.ninja/advanced-settings/mixer-scene-parameters/view), [`&scene`](https://docs.vdo.ninja/advanced-settings/mixer-scene-parameters/scene))

## Aliases

* `&posturl`

## Options

Example: `&postapi=https%3A%2F%2Fwebhook.site%2Fb190f5bf-e4f8-454a-bd51-78b5807df9c1`

<table><thead><tr><th width="203">Value</th><th>Description</th></tr></thead><tbody><tr><td>(custom POST URL)</td><td>Data JSON encoded, post URL requires HTTPS+CORS, and the passed URL parameter value needs to be encodedURLComponent</td></tr></tbody></table>

## Details

`&postapi` lets you specify a custom POST URL to send events within VDO.Ninja to.

Data JSON encoded, post URL requires HTTPS+CORS, and the passed URL parameter value needs to be encodedURLComponent.\
ie: `&postapi=https%3A%2F%2Fwebhook.site%2Fb190f5bf-e4f8-454a-bd51-78b5807df9c1`

If you don't want to listen for events with the websocket server API I host, you can use this with your own API https server instead and get key events pushed to you that way.

<div align="left"><figure><img src="https://2943598173-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MZHXv1G8N0MDxwotaT9%2Fuploads%2FTMjo0XDALfuIaXbIeldu%2Fimage.png?alt=media&#x26;token=db8d78cf-fefe-409f-b23e-7dca14acd4f6" alt=""><figcaption></figcaption></figure></div>