Webhook

Einführung

Die Webhook-Funktionalität der newscube API ermöglicht es Ihnen, automatisch über neue Nachrichten benachrichtigt zu werden, sobald sie verfügbar sind. Anstatt wiederholt Anfragen an die API zu senden, können Sie einfach einen Webhook einrichten und die gewünschten Daten per POST an Ihre URL empfangen. Dadurch sparen Sie Zeit und Ressourcen und erhalten immer aktuelle und relevante Nachrichten in Echtzeit.

Datenformat des Webhooks

Die Webhook-Anfragen enthalten die gewünschten Daten im JSON-Format und werden per POST an Ihre URL gesendet. Die folgenden Datenfelder werden in der Anfrage übermittelt:

  • document_url: Die URL, um die vollständigen Dokumentdaten im XML-Format abzurufen. Sie können diese URL verwenden, um auf die XML-Daten eines bestimmten Dokuments zuzugreifen.

  • document_url_json: Die URL, um die vollständigen Dokumentdaten im JSON-Format abzurufen. Sie können diese URL verwenden, um auf die JSON-Daten eines bestimmten Dokuments zuzugreifen.

  • stream_url: Die URL, um die vollständigen Streamdaten im XML-Format abzurufen. Sie können diese URL verwenden, um auf die XML-Daten aller Dokumente in einem Stream zuzugreifen.

  • stream_url_json: Die URL, um die vollständigen Streamdaten im JSON-Format abzurufen. Sie können diese URL verwenden, um auf die JSON-Daten aller Dokumente in einem Stream zuzugreifen.

Einrichtung des Webhooks

Um den Webhook einzurichten, müssen Sie lediglich Ihre URL an das newscube-Team per E-Mail an support@newscube.de senden. Geben Sie in der E-Mail an, an welche URL der Webhook gesendet werden soll.

Verarbeitung der Webhook-Daten

Sobald Sie den Webhook eingerichtet haben, empfangen Sie automatisch die gewünschten Daten per POST-Anfrage an Ihre URL. Ihre Webanwendung muss in der Lage sein, die empfangenen Daten zu verarbeiten und entsprechend zu reagieren.

Beispielanfrage

Hier ist ein Beispiel für die Daten, die in einer Webhook-Anfrage gesendet werden:

{
  "document_url": "https://export.newscube.de/v2/document/8821480584db044351ede3331614015/xml?uuid=6148470704db044351eefe363335568",
  "document_url_json": "https://export.newscube.de/v2/document/8821480584db044351ede3331614015/json?uuid=6148470704db044351eefe363335568",
  "stream_url": "https://export.newscube.de/v2/documents/xml?uuid=6148470704db044351eefe363335568",
  "stream_url_json": "https://export.newscube.de/v2/documents/json?uuid=6148470704db044351eefe363335568"
}

Hinweis

Die URLs des Webhooks enthalten nicht Ihren API-Schlüssel. Diesen müssen Sie als key Parameter vor dem Abrufen der Streams an die URL anhängen.

Support

Wenn Sie Fragen oder Probleme bei der Einrichtung oder Verwendung des Webhooks haben, stehen wir Ihnen gerne zur Verfügung. Kontaktieren Sie uns per E-Mail unter support@newscube.de, und unser Support-Team wird Ihnen so schnell wie möglich behilflich sein.

Vielen Dank, dass Sie die Webhook-Funktionalität der newscube API nutzen. Wir freuen uns darauf, Ihnen hochwertige Nachrichtendaten in Echtzeit zur Verfügung zu stellen!