Register a new webhook for an event type. When the specified event occurs, a POST request will be sent to the provided URL.

POST

https://host.com/v1/webhook

X-API-Keystring

API Key authentication. Generate your API key in the Gail Portal under General > Integrations > API Keys.

The webhook configuration including event type and destination URL.

eventenumOptional

urlstring or nullOptional

Created

eventenum

urlstring or null

idstringOptionalformat: "uuid"

isArchivedbooleanOptional

400

Bad Request Error

1	const url = 'https://host.com/v1/webhook';
2	const options = {
3	method: 'POST',
4	headers: {'X-API-Key': '<apiKey>', 'Content-Type': 'application/json'},
5	body: '{}'
6	};
7
8	try {
9	const response = await fetch(url, options);
10	const data = await response.json();
11	console.log(data);
12	} catch (error) {
13	console.error(error);
14	}