events

Creates, updates, deletes, gets or lists an events resource.

Overview

Name	events
Type	Resource
Id	vercel.marketplace.events

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create	insert	integration_configuration_id, event		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.<br /> <br /> resource.updated event should be dispatched when any state of a resource linked to Vercel is modified by the partner.<br /> installation.updated event should be dispatched when an installation's billing plan is changed via the provider instead of Vercel.<br /> <br /> Resource update use cases: <br /> <br /> - 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.<br /> - 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.<br />

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
integration_configuration_id	string

INSERT examples

create

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.<br /> <br /> resource.updated event should be dispatched when any state of a resource linked to Vercel is modified by the partner.<br /> installation.updated event should be dispatched when an installation's billing plan is changed via the provider instead of Vercel.<br /> <br /> Resource update use cases: <br /> <br /> - 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.<br /> - 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.<br />

INSERT INTO vercel.marketplace.events (
event,
integration_configuration_id
)
SELECT 
'{{ event }}' /* required */,
'{{ integration_configuration_id }}'
;

Manifest

# Description fields are for documentation purposes
- name: events
props:
  - name: integration_configuration_id
    value: "{{ integration_configuration_id }}"
    description: Required parameter for the events resource.
  - name: event
    value:
      type: "{{ type }}"
      billingPlanId: "{{ billingPlanId }}"
      productId: "{{ productId }}"
      resourceId: "{{ resourceId }}"