WebhooksClient

​

Sous-modules

• Module xdk.webhooks.client
  • WebhooksClient
    • WebhooksClient.__init__()
    • WebhooksClient.create()
    • WebhooksClient.create_stream_link()
    • WebhooksClient.create_webhook_replay_job()
    • WebhooksClient.delete()
    • WebhooksClient.delete_stream_link()
    • WebhooksClient.get()
    • WebhooksClient.get_stream_links()
    • WebhooksClient.validate()
• Module xdk.webhooks.models
  • CreateRequest
    • CreateRequest.model_config
  • CreateResponse
    • CreateResponse.model_config
  • CreateStreamLinkResponse
    • CreateStreamLinkResponse.model_config
  • CreateWebhookReplayJobRequest
    • CreateWebhookReplayJobRequest.model_config
  • CreateWebhookReplayJobResponse
    • CreateWebhookReplayJobResponse.model_config
  • DeleteResponse
    • DeleteResponse.model_config
  • DeleteStreamLinkResponse
    • DeleteStreamLinkResponse.model_config
  • GetResponse
    • GetResponse.model_config
  • GetStreamLinksResponse
    • GetStreamLinksResponse.model_config
  • ValidateResponse
    • ValidateResponse.model_config

​

Contenu du module

Ce module donne accès aux endpoints de webhooks de X API et constitue le point d’entrée principal pour toutes les fonctionnalités liées aux webhooks.

​

class xdk.webhooks.WebhooksClient

Client pour les opérations liées aux webhooks

​

Paramètres

path.client · Client

​

__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

​

create_stream_link

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’identifiant du webhook à lier à votre ensemble de règles FilteredStream.

path.tweet_fields · str or None · défaut: "None"

Une liste de champs Tweet séparés par des virgules à afficher.

path.expansions · str or None · défaut: "None"

Une liste de champs séparés par des virgules à étendre.

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.

​

Renvoie

CreateStreamLinkResponse - Données de la réponse

​

create_webhook_replay_job

Créer un job de relecture pour le webhook Crée un job de relecture pour récupérer les événements des 24 dernières heures pour tous les événements livrés ou ayant fait l’objet d’une tentative de livraison au webhook. 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 la configuration d’un webhook existant.

​

Paramètres

path.webhook_id · Any

L’identifiant du webhook à supprimer.

​

Valeur de retour

DeleteResponse - Données de la réponse

​

delete_stream_link

Supprimer le lien de flux Supprime un lien entre les événements FilteredStream et le webhook indiqué.

​

Paramètres

path.webhook_id · Any

L’ID de webhook à associer à votre jeu de règles FilteredStream.

​

Renvoie

DeleteStreamLinkResponse - Données de la réponse

​

get

Obtenir le webhook Obtenir la liste des configurations de webhook associées à une App cliente.

​

Paramètres

path.webhook_config_fields · List or None · défaut: "None"

Une liste, séparée par des virgules, des champs WebhookConfig à afficher.

​

Renvoie

GetResponse - Données de la réponse

​

get_stream_links

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

​

Renvoie

GetStreamLinksResponse

​

validate

Validation du webhook Déclenche un contrôle CRC pour un webhook donné.

​

Paramètres

path.webhook_id · Any

L’identifiant du webhook à vérifier.

​

Renvoie

ValidateResponse - Données de la réponse