POST /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.
Servers
Path parameters
| Name |
Type |
Required |
Description |
integrationConfigurationId |
String |
Yes |
|
Request headers
| Name |
Type |
Required |
Description |
Content-Type |
String |
Yes |
The media type of the request body.
Default value: "application/json"
|
Request body fields
| Name |
Type |
Required |
Description |
event |
|
Yes |
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.
