[POST] /webhooks

Create a new webhooks subscriptions by using the /webhooks REST API to start receiving real-time data payload on your endpoint whenever the subscribed event occurs.

Header

Name	Type	Description
Authorization	String	The AIrstack API key.

Body

Name	Type	Description
endpoint	String	The endpoint URL where the webhook is going to push the payload to. For testing purpose, you can use webhook.site.
filter_config	FilterConfig	Webhook filter configuration to only receive certain events that fulfilled the defined filter. If you are unsure whether your filter is valid or not, you can use this API to do so.

Success Response (Status 200)

Name	Type	Description
webhook_id	String	ID associated to the webhook.
portal_link	String	Portal link to see all available webhooks created.
authentication	Authentication	Authentication field to verify payload received to confirm that it comes from Airstack.
status	Boolean	true
message	String	Success message from webhook creation.

Fail Response (Status 400)

Name	Type	Description
authentication	Authentication	Empty object {}
status	Boolean	false
message	String	Error message.