POST
/
public
/
v1
/
webhooks
Add New Webhook
curl --request POST \
  --url https://api.fello.ai/public/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "url": "https://example.com/webhook",
  "eventType": "FormSubmission"
}'
{
  "subscriptionId": "<unique-subscription-id>",
  "url": "https://example.com/webhook",
  "eventType": "FormSubmission",
  "status": "Active",
  "createdAt": "2021-01-01T00:00:00.000Z",
  "updatedAt": "2021-02-01T00:00:00.000Z"
}

Authorizations

​
x-api-key
string
header
required

The API Key generated from your Fello account.

Body

application/json
​
url
string
Maximum length: 256
Example:

"https://example.com/webhook"

​
eventType
enum<string>
Available options:
FormSubmission,
ContactEnriched,
DashboardClick,
EmailClick,
PostcardScan,
ContactUnsubscribed,
ContactDetailsUpdated
Example:

"FormSubmission"

Response

Success

​
subscriptionId
string
Example:

"<unique-subscription-id>"

​
url
string
Maximum length: 256
Example:

"https://example.com/webhook"

​
eventType
enum<string>
Available options:
FormSubmission,
ContactEnriched,
DashboardClick,
EmailClick,
PostcardScan,
ContactUnsubscribed,
ContactDetailsUpdated
Example:

"FormSubmission"

​
status
enum<string>
Available options:
Active,
Removed,
Failing
Example:

"Active"

​
createdAt
string
Example:

"2021-01-01T00:00:00.000Z"

​
updatedAt
string
Example:

"2021-02-01T00:00:00.000Z"