SIsilverfin
Webhooks

Register a webhook.

<b>Required scope(s):</b> webhooks

post/api/v4/f/{firm_id}/companies/{company_id}/webhooks

Request

  • Base URL
    https://live.getsilverfin.com
  • URL
    https://live.getsilverfin.com/api/v4/f/{firm_id}/companies/{company_id}/webhooks
  • Auth
    OAuth 2
    Authorization code: https://live.getsilverfin.com/oauth/authorize
    Token URL: https://live.getsilverfin.com/oauth/token scopes: webhooks

Path parameters

firm_idinteger required
company_idinteger required

Headers

Acceptstring

Request body multipart/form-data

urlstring required

Valid https url

events[]string[] required

List of events that will trigger this webhook, you cannot update this list, so you should destroy the webhook and create a new one when you want to add or remove an event.

Response

Successful response

idinteger

webhook_id

urlstring
eventsstring[]
user_idinteger
expired_atstring

Changes

No recorded changes to this operation across all 2 revisions of this API.