Passer au contenu principal

WebhooksClient

Classe Classe de base : object Client pour les opérations de webhooks

Constructeurs

__init__

Paramètres

path.client
Client

create

Créer un webhook Crée une nouvelle configuration de webhook. body: Corps de la requête :returns: Données de la réponse :rtype: CreateResponse

Paramètres

body.body
CreateRequest
Créer un lien de flux Crée un lien pour acheminer les événements FilteredStream vers le webhook spécifié.

Paramètres

path.webhook_id
Any
L’id du webhook à lier à votre jeu de règles FilteredStream.
path.tweet_fields
str or None
défaut:"None"
Une liste de champs de Tweet, séparés par des virgules, à afficher.
path.expansions
str or None
défaut:"None"
Une liste de champs à étendre, séparés par des virgules.
path.media_fields
str or None
défaut:"None"
Une liste de champs Media, séparés par des virgules, à afficher.
path.poll_fields
str or None
défaut:"None"
Une liste de champs Poll, séparés par des virgules, à afficher.
path.user_fields
str or None
défaut:"None"
Une liste de champs User, séparés par des virgules, à afficher.
path.place_fields
str or None
défaut:"None"
Une liste de champs Place, séparés par des virgules, à afficher.

Valeur de retour

CreateStreamLinkResponse - Données de réponse

create_webhook_replay_job

Créer un job de relecture pour un webhook Crée un job de relecture pour récupérer, pour ce webhook, les événements des 24 dernières heures qui ont été livrés ou dont la livraison a été tentée. body: Corps de la requête :returns: Données de la réponse :rtype: CreateWebhookReplayJobResponse

Paramètres

body.body
CreateWebhookReplayJobRequest

delete

Supprimer un webhook Supprime une configuration de webhook existante.

Paramètres

path.webhook_id
Any
L’identifiant du webhook à supprimer.

Retourne

DeleteResponse - Données de réponse Supprimer un lien de flux Supprime un lien entre les événements FilteredStream et le webhook spécifié.

Paramètres

path.webhook_id
Any
L’ID du webhook à associer à votre jeu de règles FilteredStream.

Valeur de retour

DeleteStreamLinkResponse - Données de réponse

get

Récupérer un webhook Récupérer la liste des configurations de webhooks associées à une App cliente.

Paramètres

path.webhook_config_fields
List or None
défaut:"None"
Une liste de champs WebhookConfig à afficher, séparés par des virgules.

Renvoie

GetResponse - données de réponse Récupérer les liens de flux Récupérer une liste de liens de webhook associés à un jeu de règles de flux filtré. :returns: Données de la réponse :rtype: GetStreamLinksResponse

Retourne

GetStreamLinksResponse

validate

Valider le webhook Déclenche un contrôle CRC pour le webhook fourni.

Paramètres

path.webhook_id
Any
L’identifiant du webhook à vérifier.

Retourne

ValidateResponse - Données de la réponse