Menu

Create Event

POSThttps://api.vercel.com/v1/installations/{integrationConfigurationId}/events
Partner notifies Vercel of any changes made to an Installation or a Resource. Vercel is expected to use list-resources and other read APIs to get the new state.

resource.updated event should be dispatched when any state of a resource linked to Vercel is modified by the partner.
installation.updated event should be dispatched when an installation's billing plan is changed via the provider instead of Vercel.

Resource update use cases:

- The user renames a database in the partner’s application. The partner should dispatch a resource.updated event to notify Vercel to update the resource in Vercel’s datastores.
- A resource has been suspended due to a lack of use. The partner should dispatch a resource.updated event to notify Vercel to update the resource's status in Vercel's datastores.
https://api.vercel.com/v1/installations/{integrationConfigurationId}/events
const response = await fetch('https://api.vercel.com/v1/installations/string/events', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"event": "value"
}),
});
const data = await response.json();
console.log(data);
Response
{}
AuthorizationbearerToken

Default authentication mechanism

integrationConfigurationIdstringRequired

This endpoint expects an object.

eventobjectRequired

No response body

400One of the provided values in the request body is invalid. One of the provided values in the request query is invalid.
401The request is not authorized.
403You do not have permission to access this resource.
404Error
Create Event | Vercel API