POST
/
v1
/
companies
/
{company_id}
/
webhooks
curl --request POST \
  --url https://api.gofermata.com/v1/companies/{company_id}/webhooks \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "<string>",
  "username": "<string>",
  "password": "<string>"
}'
{
  "data": {
    "id": "<string>",
    "company_id": "<string>",
    "url": "<string>",
    "username": "<string>",
    "password": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

To authenticate against the API, use HTTP Basic Authentication with your customer ID as the username and API key as the password.

Path Parameters

​
company_id
string
required

Body

application/json
​
url
string

The URL to send the webhook request

​
username
string

A username that Fermata will send to this webhook using HTTP Basic Auth to prove the request is coming from us

​
password
string

A password that Fermata will send to this webhook using HTTP Basic Auth to prove the request is coming from us

Response

200 - application/json
OK
​
data
object
Get webhooksSubscribe a Webhook URL to a specific topic