Webhook

Endpoints for managing webhook subscriptions: list current subscriptions, register new endpoint URLs, remove existing ones, and send a test event to verify a subscription.

List webhook subscriptions

get

Lists all the URLs that are currently subscribed to receive events via webhooks.

Authorizations

AuthorizationstringRequired

Authorize your requests using a tenant's API Key. Use this method of security only in server-to-server interactions.

Path parameters

tenant_aliasstringRequired

Tenant being referenced. E.g. "aboih12h16t" or "test_abo912126tastastt"

Responses

200

A list of endpoints

application/json

An endpoint to receive events

endpointUrlstringOptional

The url of the endpoint that receives events.

Example: http://app.example.com/endpoint/sqtch

namestringOptional

Optional name of the endpoint that receives events.

Example: Zapier

sourcestringRead-onlyOptional

How the subscription was created. Always MANUAL for subscriptions created via the API.

Example: MANUAL

webhookTypesstring[]Optional

The event types this endpoint is subscribed to. ["*"] means all event types.

Example: ["*"]

default

Unexpected Error

application/json

get/{tenant_alias}/subscription

cURL

curl -L \
  --url 'https://app.referralsaasquatch.com/api/v1/{tenant_alias}/subscription' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

[
  {
    "endpointUrl": "https://example.com/hook",
    "name": "Zapier",
    "source": "MANUAL",
    "webhookTypes": [
      "*"
    ]
  },
  {
    "endpointUrl": "https://another.example.com/hook",
    "name": "Example",
    "source": "MANUAL",
    "webhookTypes": [
      "*"
    ]
  }
]

Create a webhook subscription

post

Subscribes a URL to receive events via webhooks.

Authorizations

AuthorizationstringRequired

Authorize your requests using a tenant's API Key. Use this method of security only in server-to-server interactions.

Path parameters

tenant_aliasstringRequired

Tenant being referenced. E.g. "aboih12h16t" or "test_abo912126tastastt"

Body

An endpoint to receive events

endpointUrlstringOptional

The url of the endpoint that receives events.

Example: http://app.example.com/endpoint/sqtch

namestringOptional

Optional name of the endpoint that receives events.

Example: Zapier

sourcestringRead-onlyOptional

How the subscription was created. Always MANUAL for subscriptions created via the API.

Example: MANUAL

webhookTypesstring[]Optional

The event types this endpoint is subscribed to. ["*"] means all event types.

Example: ["*"]

Responses

201

Webhook endpoint created

No content

default

Unexpected Error

application/json

post/{tenant_alias}/subscription

cURL

curl -L \
  --request POST \
  --url 'https://app.referralsaasquatch.com/api/v1/{tenant_alias}/subscription' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

No content

Delete a webhook subscription

delete

Removes a URL from receiving events via webhooks.

Authorizations

AuthorizationstringRequired

Authorize your requests using a tenant's API Key. Use this method of security only in server-to-server interactions.

Path parameters

tenant_aliasstringRequired

Tenant being referenced. E.g. "aboih12h16t" or "test_abo912126tastastt"

urlstringRequired

The url of the endpoint that will be removed. URL-encode this field.

Responses

204

Endpoint deleted

No content

default

Unexpected Error

application/json

delete/{tenant_alias}/subscription/{url}

cURL

curl -L \
  --request DELETE \
  --url 'https://app.referralsaasquatch.com/api/v1/{tenant_alias}/subscription/{url}' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

No content

Test a webhook subscription

post

Sends a test event to the specified webhook.

Authorizations

AuthorizationstringRequired

Authorize your requests using a tenant's API Key. Use this method of security only in server-to-server interactions.

Path parameters

tenant_aliasstringRequired

Tenant being referenced. E.g. "aboih12h16t" or "test_abo912126tastastt"

urlstringRequired

The url of the endpoint to send a test message to. URL-encode this field.

Responses

204

Test message sent

No content

default

Unexpected Error

application/json

post/{tenant_alias}/subscription/{url}/test

cURL

curl -L \
  --request POST \
  --url 'https://app.referralsaasquatch.com/api/v1/{tenant_alias}/subscription/{url}/test' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

No content