The Open API specification for Synapse is now available for download!

Download Open API Spec

CreateOrUpdateWebhookRequest

org.sagebionetworks.repo.model.webhook.CreateOrUpdateWebhookRequest

Request used to create or update a webhook

Field Type Description
objectId STRING The id of the Synapse object to receive events of.
objectType SynapseObjectType The supported synapse object types for a Webhook
eventTypes SET<SynapseEventType> The list of event types to subscribe to.
invokeEndpoint STRING The webhook endpoint where the events will be sent to. Must be 255 Characters or less.
isEnabled BOOLEAN True if the webhook should be enabled. If false no events will be sent to the endpoint.