Skip to content

Latest commit

 

History

History
331 lines (296 loc) · 8.88 KB

follow.md

File metadata and controls

331 lines (296 loc) · 8.88 KB
Raw
description
Learn how to use Airstack webhooks to listen to various use cases on follow events on the Farcaster network.

🫂 Follow

Listen To All Follow Events on Farcaster

You can use Airstack webhooks to listen to all Farcaster follow events by using the following configuration:

{% tabs %} {% tab title="CURL" %}

curl -X 'POST' \
  'https://webhooks.airstack.xyz/api/v1/webhooks' \
  -H 'accept: application/json' \
  -H 'Authorization: <YOUR_AIRSTACK_API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{
  "endpoint": "https://webhook.site",
  "filter_config": {
    "event_type": "follow.created"
  }
}'

{% endtab %}

{% tab title="TypeScript" %}

// Prerequisites: npm install axios
import axios from 'axios';

const url = 'https://webhooks.airstack.xyz/api/v1/webhooks';
const headers = {
  'accept': 'application/json',
  'Authorization': 'YOUR_AIRSTACK_API_KEY',
  'Content-Type': 'application/json'
};
const data = {
  endpoint: 'https://webhook.site', // your endpoint
  filter_config: {
    event_type: 'follow.created', // Listen to all follow events
  }
};

axios.post(url, data, { headers })
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.error('There was an error!', error);
  });

{% endtab %}

{% tab title="JavaScript" %}

// Prerequisites: npm install axios
const axios = require('axios');

const url = 'https://webhooks.airstack.xyz/api/v1/webhooks';
const headers = {
  'accept': 'application/json',
  'Authorization': 'YOUR_AIRSTACK_API_KEY',
  'Content-Type': 'application/json'
};
const data = {
  endpoint: 'https://webhook.site', // your endpoint
  filter_config: {
    event_type: 'follow.created', // Listen to all follow events
  }
};

axios.post(url, data, { headers })
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.error('There was an error!', error);
  });

{% endtab %}

{% tab title="Payload" %}

{
  "id": "000000020c162a7ffcaf089ae12f3e53372302cde3c95cf6bab7b3244df5daa6",
  "dappName": "farcaster",
  "dappSlug": "farcaster_v3_optimism",
  "eventTimestamp": "2024-05-11T08:43:50.531Z",
  "followerProfileId": "3761"
  "followingProfileId": "326089",
  "followerSince": "2024-02-09T07:37:59Z"
}

{% endtab %} {% endtabs %}

Listen To Any Farcaster User That Follows A Certain Farcaster User

You can use Airstack webhooks to listen to all events when any Farcaster user follows a certain FID by using the following configuration:

{% tabs %} {% tab title="CURL" %}

curl -X 'POST' \
  'https://webhooks.airstack.xyz/api/v1/webhooks' \
  -H 'accept: application/json' \
  -H 'Authorization: <YOUR_AIRSTACK_API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{
  "endpoint": "https://webhook.site",
  "filter_config": {
    "event_type": "follow.created",
    "filter": {
      "followerProfileId": "3761"
    },
    "payload": {
      "followerProfileId": "3761",
      "followingProfileId": "326089"
    }
  }
}'

{% endtab %}

{% tab title="TypeScript" %}

// Prerequisites: npm install axios
import axios from 'axios';

const url = 'https://webhooks.airstack.xyz/api/v1/webhooks';
const headers = {
  'accept': 'application/json',
  'Authorization': 'YOUR_AIRSTACK_API_KEY',
  'Content-Type': 'application/json'
};
const data = {
  endpoint: 'https://webhook.site', // your endpoint
  filter_config: {
    event_type: 'follow.created', // Listen to follow events,
    filter: {
      followerProfileId: "3761" // filter by this FID
    },
    payload: {
      // Ensure that this field matched the value in filter
      followerProfileId: "3761"
      followingProfileId: "326089"
    }
  }
};

axios.post(url, data, { headers })
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.error('There was an error!', error);
  });

{% endtab %}

{% tab title="JavaScript" %}

// Prerequisites: npm install axios
const axios = require('axios');

const url = 'https://webhooks.airstack.xyz/api/v1/webhooks';
const headers = {
  'accept': 'application/json',
  'Authorization': 'YOUR_AIRSTACK_API_KEY',
  'Content-Type': 'application/json'
};
const data = {
  endpoint: 'https://webhook.site', // your endpoint
  filter_config: {
    event_type: 'follow.created', // Listen to follow events,
    filter: {
      followerProfileId: "3761" // filter by this FID
    },
    payload: {
      // Ensure that this field matched the value in filter
      followerProfileId: "3761"
      followingProfileId: "326089"
    }
  }
};

axios.post(url, data, { headers })
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.error('There was an error!', error);
  });

{% endtab %}

{% tab title="Payload" %}

{
  "id": "000000020c162a7ffcaf089ae12f3e53372302cde3c95cf6bab7b3244df5daa6",
  "dappName": "farcaster",
  "dappSlug": "farcaster_v3_optimism",
  "eventTimestamp": "2024-05-11T08:43:50.531Z",
  "followerProfileId": "3761"
  "followingProfileId": "326089",
  "followerSince": "2024-02-09T07:37:59Z"
}

{% endtab %} {% endtabs %}

Listen To A Farcaster User When Following Another Farcaster User

You can use Airstack webhooks to listen to all follow events when a Farcaster user is following another Farcaster user by using the following configuration:

{% tabs %} {% tab title="CURL" %}

curl -X 'POST' \
  'https://webhooks.airstack.xyz/api/v1/webhooks' \
  -H 'accept: application/json' \
  -H 'Authorization: <YOUR_AIRSTACK_API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{
  "endpoint": "https://webhook.site",
  "filter_config": {
    "event_type": "follow.created",
    "filter": {
      "followingProfileId": "326089"
    },
    "payload": {
      "followerProfileId": "3761",
      "followingProfileId": "326089"
    }
  }
}'

{% endtab %}

{% tab title="TypeScript" %}

// Prerequisites: npm install axios
import axios from 'axios';

const url = 'https://webhooks.airstack.xyz/api/v1/webhooks';
const headers = {
  'accept': 'application/json',
  'Authorization': 'YOUR_AIRSTACK_API_KEY',
  'Content-Type': 'application/json'
};
const data = {
  endpoint: 'https://webhook.site', // your endpoint
  filter_config: {
    event_type: 'follow.created', // Listen to follow events,
    filter: {
      followingProfileId: "326089" // filter by this FID
    },
    payload: {
      followerProfileId: "3761"
      // Ensure that this field matched the value in filter
      followingProfileId: "326089"
    }
  }
};

axios.post(url, data, { headers })
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.error('There was an error!', error);
  });

{% endtab %}

{% tab title="JavaScript" %}

// Prerequisites: npm install axios
const axios = require('axios');

const url = 'https://webhooks.airstack.xyz/api/v1/webhooks';
const headers = {
  'accept': 'application/json',
  'Authorization': 'YOUR_AIRSTACK_API_KEY',
  'Content-Type': 'application/json'
};
const data = {
  endpoint: 'https://webhook.site', // your endpoint
  filter_config: {
    event_type: 'follow.created', // Listen to follow events,
    filter: {
      followingProfileId: "326089" // filter by this FID
    },
    payload: {
      followerProfileId: "3761"
      // Ensure that this field matched the value in filter
      followingProfileId: "326089"
    }
  }
};

axios.post(url, data, { headers })
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.error('There was an error!', error);
  });

{% endtab %}

{% tab title="Payload" %}

{
  "id": "000000020c162a7ffcaf089ae12f3e53372302cde3c95cf6bab7b3244df5daa6",
  "dappName": "farcaster",
  "dappSlug": "farcaster_v3_optimism",
  "eventTimestamp": "2024-05-11T08:43:50.531Z",
  "followerProfileId": "3761"
  "followingProfileId": "326089",
  "followerSince": "2024-02-09T07:37:59Z"
}

{% endtab %} {% endtabs %}

Developer Support

If you have any questions or need help regarding creating webhook for listening to Farcaster following events, please join our Airstack's Telegram group.

More Resources