POST /2/activity/subscriptions

Creates a subscription for an X activity event

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
filter Object Yes

An XAA subscription filter.

filter.direction String No

Optional direction filter for directional events.

Valid values:

  • "inbound"
  • "outbound"
filter.keyword String No

A keyword to filter on.

filter.user_id String No

Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.

event_type String Yes

Valid values:

  • "dm.read"
  • "profile.update.url"
  • "profile.update.geo"
  • "spaces.end"
  • "news.new"
  • "profile.update.affiliate_badge"
  • "profile.update.profile_picture"
  • "chat.sent"
  • "chat.conversation_join"
  • "dm.indicate_typing"
  • "profile.update.bio"
  • "follow.follow"
  • "dm.sent"
  • "dm.received"
  • "spaces.start"
  • "chat.received"
  • "profile.update.banner_picture"
  • "profile.update.screenname"
  • "profile.update.verified_badge"
  • "profile.update.handle"
  • "follow.unfollow"
tag String No
webhook_id String No

The unique identifier of this webhook config.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.