POST /webhook
Create a new webhook. A user can create a maximum of 25 webhooks. Once created the webhook needs to be verified using the POST /webhook/{webhookId}/verify request with the verification code received by the webhook endpoint.
The webhook endpoint is checked against a white list of allowed domain patterns, currently only the AWS Api Gateway execute-api is allowed. For adding a new domain exception you can submit a request to the Synapse Service Desk.
The caller must have READ permissions on the entity specified in the request, this permission needs to be maintained in order to receive events.
Resource URL
https://repo-prod.prod.sagebase.org/repo/v1/webhook
Resource Information | |
---|---|
Authentication | Required |
Required OAuth Scopes | view , modify |
HTTP Method | POST |
Request Object | CreateOrUpdateWebhookRequest (application/json) |
Response Object | Webhook (application/json) |