Skip to main content
A Account Activity API (AAA) está sendo descontinuada. Confira a X Activity API (XAA) para a entrega de atividades de usuário em tempo real daqui para frente.
A Account Activity API (AAA) oferece uma forma de receber eventos em tempo real relacionados às contas de usuários do X via webhooks. Ao assinar contas de usuários específicos em um webhook pré-configurado, sua aplicação pode ser notificada sobre diversas atividades, como Posts, Direct Messages, Curtidas, Follows, Blocks e muito mais, de uma ou mais das suas contas próprias ou assinadas por meio de uma única conexão. Essa API é comumente usada para criar aplicações que precisam reagir instantaneamente às ações de usuários ou manter um estado atualizado com base na atividade dos usuários.

Visão geral

Entrega via webhook

Eventos entregues ao seu servidor em tempo real

Tempo real

Entrega dados na velocidade do X — sem necessidade de polling

Abrangente

Posts, DMs, follows, curtidas, blocks, mutes e mais

Baseada em assinaturas

Assine contas de usuários para receber toda a atividade delas

Como funciona

  1. Registre o webhook — Registre a URL do seu webhook via a V2 Webhooks API
  2. Assine usuários — Adicione assinaturas de usuários ao seu webhook
  3. Receba eventos — Receba eventos de atividade entregues como requisições POST com payloads em JSON
  4. Processe eventos — Trate os eventos em sua aplicação e responda com 200 OK

Tipos de atividade

Você receberá todas as atividades relacionadas abaixo para cada assinatura de usuário no seu registro de webhook:
  • Posts (pelo usuário)
  • Exclusões de Post (pelo usuário)
  • @menções (do usuário)
  • Respostas (para ou do usuário)
  • Reposts (pelo usuário ou do usuário)
  • Quote Posts (pelo usuário ou do usuário)
  • Reposts de Quoted Posts (pelo usuário ou do usuário)
  • Curtidas (pelo usuário ou do usuário)
  • Follows (pelo usuário ou do usuário)
  • Unfollows (pelo usuário ou do usuário)
  • Blocks (pelo usuário ou do usuário)
  • Unblocks (pelo usuário ou do usuário)
  • Mutes (pelo usuário ou do usuário)
  • Unmutes (pelo usuário ou do usuário)
  • Direct Messages enviadas (pelo usuário)
  • Direct Messages recebidas (pelo usuário)
  • Indicadores de digitação (para o usuário)
  • Confirmações de leitura (para o usuário)
  • Revogações de assinatura (pelo usuário)
Não entregamos dados da home timeline pela Account Activity API. Use o endpoint User Posts timeline by User ID para obter esses dados.Os Posts retornados pela Account Activity API contam para o Post cap mensal.

Resumo de recursos


Estrutura do objeto de dados de Account Activity

Atividades disponíveis


Exemplos de payload

Abaixo estão exemplos de payload para cada evento de Account Activity.

tweet_create_events (Posts, Retweets, Respostas, QuoteTweets)

tweet_create_events (@menções)

favorite_events

follow_events

unfollow_events

block_events

unblock_events

mute_events

unmute_events

user_event

direct_message_events

direct_message_indicate_typing_events

direct_message_mark_read_events

tweet_delete_events


Suporte a posts em formato longo (longform)

A Account Activity API V2 oferece suporte a posts longform, ou seja, posts que ultrapassam 280 caracteres. Quando um post longform é incluído em um payload tweet_create_events, o campo text contém os primeiros 140 caracteres (ou menos), e o campo truncated é definido como true. O conteúdo completo do post é entregue no objeto extended_tweet, que inclui:
  • full_text — O texto completo do post, incluindo todos os caracteres além do limite de 280 caracteres.
  • entities — Quaisquer entidades (por exemplo, hashtags, URLs, menções de usuário, símbolos) presentes no texto completo, incluindo aquelas que aparecem depois do 280º caractere.
  • display_text_range — O intervalo de caracteres a ser exibido, considerando o texto completo.
Isso garante que as aplicações possam processar todo o conteúdo dos posts longform, incluindo menções ou outras entidades que apareçam mais adiante no texto. Abaixo, um exemplo de payload tweet_create_events para um post longform:

Perguntas frequentes

A Account Activity API utiliza webhooks, entregando dados em tempo real sem exigir uma conexão aberta (diferente das APIs de streaming) ou polling frequente (diferente das APIs REST). Os benefícios incluem:
  • Velocidade — Entrega dados na velocidade do X.
  • Simplicidade — Fornece todos os eventos da conta por meio de uma única conexão de webhook, incluindo Posts, @menções, Respostas, Reposts, Quote Tweets, Curtidas, DMs, Follows, Blocks e Mutes.
  • Escala — Suporta todas as atividades das contas gerenciadas sem rate limits ou limites de eventos (nível Enterprise).
Sim! Você pode registrar várias URLs de webhook e gerenciar as assinaturas separadamente pela V2 Webhooks API.
Os requisitos de autenticação variam por endpoint:
  • Ações específicas do usuário (por exemplo, assinar um usuário) exigem OAuth 1.0a (fluxo OAuth 3-legged).
  • Ações no nível do app (por exemplo, listar/excluir assinaturas, contagem de assinaturas) exigem OAuth2 App Only Bearer Token.
Consulte a seção de autenticação para mais detalhes.
Sim. Se seu app tem assinaturas para o Usuário A e o Usuário B, e o Usuário A menciona o Usuário B em um Post, seu webhook recebe dois eventos (um por usuário). Use o campo for_user_id para identificar a assinatura.
Não. O produto /all/ é a única opção, entregando todos os tipos de evento suportados.
O limite de webhooks é definido no nível da conta, não por app. Por exemplo, com três webhooks e dois apps, você poderia usar dois webhooks para um app e um para o outro, mas não três por app.

Índice da referência da API

Para os endpoints de gerenciamento de webhooks (registrar, visualizar, validar, excluir), consulte a documentação da V2 Webhooks API.

Primeiros passos

Pré-requisitos
  • Uma conta de desenvolvedor aprovada
  • Um Project e App no Developer Console
  • Um endpoint de webhook HTTPS acessível publicamente
  • Acesso Enterprise ou Pay Per Use à Account Activity API

Início rápido

Configure assinaturas e comece a receber eventos

Webhooks API

Registre e gerencie seus webhooks

Guia de migração

Migre do Enterprise legado para o v2

Activity stream

Alternativa em streaming aos webhooks