Webhook
org.sagebionetworks.repo.model.webhook.Webhook
An object that serves as registration for a Synapse user to receive events for the specified event.
| Field | Type | Description |
|---|---|---|
| id | STRING | The ID associated with the Webhook. This field is issued by Synapse and cannot be changed by the user. |
| createdBy | STRING | The ID of the user that created this webhook. |
| createdOn | STRING | The date this webhook was created. |
| modifiedOn | STRING | The date this webhook was last modified. |
| 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 set of event types to subscribe to. |
| invokeEndpoint | STRING | The endpoint the Synapse user would like the webhook events sent to on invocation. Must be 255 Characters or less. |
| isEnabled | BOOLEAN | True if the Synapse user has selected to receive events. If the user sets to false, events will be temporalily paused. |
| verificationStatus | WebhookVerificationStatus | JSON enum for the verification status of a Webhook. |
| verificationMsg | STRING | A message describing the reason of the verification status |