Webhooks
Details about Webhooks support.
Monitors
Setting up your own custom data source to hook into Advite is not yet supported.
However…
Do you really want it? Should we bring it to the top of our list? Request it!
Email us at support@advite.ai - we will return your email in 24h or less.
Connections
Using a Webhook to get Advite alerts outside of the Console is implemented, but it’s in Beta.
Email us at support@advite.ai with your interest and we can help with the setup.
Webhook Request Body
This is the request body for a feed notification containing scan information and post details.
Top-level fields
| Field | Type | Description |
|---|---|---|
type | string | Oneof SCAN — indicates the notification type. |
name | string | The resource name of the scan. |
post | object | Details about the scanned post. The structure depends on the post type. |
Post Types
The post field varies by post.type value:
REDDIT_LINK
| Field | Type | Description |
|---|---|---|
type | string | "REDDIT_LINK" |
time | string (date-time) | When the post occurred (ISO8601) |
id | string | Post ID |
title | string | Post title |
text | string | Post text |
url | string | Post URL |
subreddit.id | string | Subreddit ID |
subreddit.name | string | Subreddit name |
subreddit.url | string | Subreddit url |
user.id | string | User ID |
user.name | string | User name |
user.url | string | User url |
TWITTER_TWEET
| Field | Type | Description |
|---|---|---|
type | string | "TWITTER_TWEET" |
time | string (date-time) | When the post occurred (ISO8601) |
id | string | Post ID |
text | string | Post text |
url | string | Post URL |
user.id | string | User ID |
user.name | string | User name |
FACEBOOK_GROUP_POST
| Field | Type | Description |
|---|---|---|
type | string | "FACEBOOK_GROUP_POST" |
time | string (date-time) | When the post occurred (ISO8601) |
id | string | Post ID |
text | string | Post text |
url | string | Post URL |
group.id | string | Group ID |
group.name | string | Group name |
group.url | string | Group URL |
group.description | string | null | Group description (optional) |
user.id | string | User ID |
user.name | string | User name |
user.url | string | User URL |
INSTAGRAM_POST
| Field | Type | Description |
|---|---|---|
type | string | "INSTAGRAM_POST" |
time | string (date-time) | When the post occurred (ISO8601) |
id | string | Post ID |
text | string | Post text |
url | string | Post URL |
comments | array of string | null | Selection of post comments (optional) |
user.id | string | User ID |
user.name | string | User name |
user.url | string | User URL |
TIKTOK_POST
| Field | Type | Description |
|---|---|---|
type | string | "TIKTOK_POST" |
time | string (date-time) | When the post occurred (ISO8601) |
id | string | Post ID |
text | string | Post text |
url | string | Post URL |
user.id | string | User ID |
user.name | string | User name |
user.url | string | User URL |
YOUTUBE_POST
| Field | Type | Description |
|---|---|---|
type | string | "YOUTUBE_POST" |
time | string (date-time) | When the post occurred (ISO8601) |
id | string | Post ID |
title | string | Post title |
text | string | Post text |
transcript | string | null | Post transcript (optional) |
url | string | Post URL |
user.id | string | User ID |
user.name | string | User name |
user.url | string | User URL |
FEATURED_POST
| Field | Type | Description |
|---|---|---|
type | string | "FEATURED_POST" |
time | string (date-time) | When the post occurred (ISO8601) |
id | string | Post ID |
text | string | Post text |
deadline | string (date-time) | Post deadline (ISO8601) |
url | string | Post URL |
source.id | string | Source ID |
source.name | string | Source name |
source.url | string | Source URL |
SUBSTACK_POST
| Field | Type | Description |
|---|---|---|
type | string | "SUBSTACK_POST" |
time | string (date-time) | When the post occurred (ISO8601) |
id | string | Post ID |
title | string | Post title |
subtitle | string | null | Post subtitle |
text | string | Post text |
url | string | Post URL |
user.id | string | User ID |
user.name | string | User name |
user.url | string | User URL |