API Reference

Create a Webhook Callback

post
https://gateway.remote.com/v1/webhook-callbacks

Register a callback to be used for webhooks

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Client credentials access token (OAuth2ClientCredentials) — obtained through the Client Credentials flow or the Refresh Token flow. See Authentication for partners.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage company resources (company_admin)-Manage webhooks (webhook:write)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

WebhookCallback

Webhook callback creation params. Provide either subscribed_events or subscribe_to_all_events: true (they are mutually exclusive).

boolean
Defaults to false

When true, subscribe this callback to all current and future event types. Cannot be combined with subscribed_events.

subscribed_events
array of strings
subscribed_events
string
required
Responses

Callback

Updated 4 months ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?