Freigeben über

BlueInk

Mit dem Blueink-Connector können Sie die eSignature-Plattform von Blueink zu automatisierten Workflows hinzufügen. Mit dem Connector können Sie den Bündelstatus überprüfen, neue Bündel erstellen, auf Anmeldeinformationen zugreifen und vieles mehr.

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Dienstleistung Class Regions
Copilot Studio Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Logik-Apps Norm Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche:
     – Azure Government-Regionen
     - Azure China-Regionen
     - US Department of Defense (DoD)
Power Apps Premium Alle Power Apps-Regionen mit Ausnahme der folgenden:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Power Automate Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Kontakt
Name Blueink-Unterstützung
URL https://help.blueink.com/en/
Email support@blueink.com
Connectormetadaten
Herausgeber Blauink
Webseite https://blueink.com
Datenschutzrichtlinie https://blueink.com/privacy-policy/
Kategorien Unternehmensführung; Produktivität

Mit diesem vielseitigen Connector können Benutzer die leistungsstarke eSignature-Lösung von Blueink nahtlos in ihren Workflow integrieren, indem sie die Funktionen verschiedener Power Automate-Connectors nutzen. Mit dieser Integration können Benutzer die Erstellung und Verteilung von Dokumentpaketen mühelos automatisieren. Durch die Orchestrierung der harmonischen Interaktion dieses Connectors mit anderen Connectors können Sie Ihre Dokumentverwaltungsprozesse optimieren, die Effizienz steigern und eine nahtlose und effiziente Dokumentsignierung für Ihre Kunden und Projektbeteiligten sicherstellen. Ganz gleich, ob es um die Automatisierung von Vertragsgenehmigungen, die Verarbeitung rechtlicher Dokumente oder das Verwalten von Papierarbeiten in einem anderen Kontext geht, dieser Connector bietet ein leistungsfähiges Tool, um Ihren Workflow zu optimieren und die Produktivität zu steigern.

Voraussetzungen

Um diesen Connector zu verwenden, benötigen Sie ein API-aktiviertes Konto aus blueink.com.

So erhalten Sie Anmeldeinformationen

Klicken Sie nach dem Erstellen Ihres Kontos auf die API-Schaltfläche auf der linken Seite der Seite. Drücken Sie unter "Private API-Schlüssel" die Schaltfläche " API-Schlüssel hinzufügen ". Weisen Sie der API-Taste eine Bezeichnung zu, und drücken Sie die Übermittlung. Kopieren Sie den API-Schlüssel, und speichern Sie ihn an einer beliebigen Stelle, da er nicht mehr angezeigt wird.

Erste Schritte mit Ihrem Connector

Beim ersten Erstellen einer Blueink-Verbindung werden Sie aufgefordert, einen API-Schlüssel einzugeben. Ihr API-Schlüssel muss immer mit dem Token beginnen, gefolgt von einem Leerzeichen und dann dem von Ihnen erstellten API-Schlüssel. Die Eingabe Ihres API-Schlüssels sollte wie dieser Token-API-SCHLÜSSEL <>aussehen.

Eine beliebte Aktion besteht darin, ein Bündel zu erstellen. Das Erstellen eines Bündels erfordert einen komplexen Satz von Eingaben. Sehen Sie sich unsere API-Dokumentation an https://blueink.com/esignature-api/api-docs/#tag/Bundles/operation/createBundle , wie die Textvariable aussehen könnte. Abbildung unten als Beispiel für einen Bündelerstellungstext.

Erstellen eines Bündels

Es gibt mehrere Möglichkeiten zum Erstellen eines Bündels, und Sie können diesen JSON-Code entsprechend dem Bundle ändern, das Sie erstellen möchten. Sehen Sie sich die API an, um weitere Möglichkeiten zu erhalten, wie dieser JSON-Code geändert werden kann. Diese Vorlage verwendet eine zuvor erstellte Vorlage, die der Benutzer in ihrem Konto eingerichtet hat.

Das Auflisten aller abgeschlossenen Bündel ist ein weiterer beliebter Endpunkt. Fügen Sie die Aktion "Listenbundle" hinzu, und ändern Sie dann die Statusschaltfläche für abgeschlossene Bündel. Sie können mit diesem Endpunkt alle Ihre neuesten abgeschlossenen Bündel auf dem neuesten Stand halten.

Auflisten von Bündeln

Bekannte Probleme und Einschränkungen

Ein JSON-Textkörper ist für den Bündelerstellungsendpunkt erforderlich.

Häufige Fehler und Abhilfemaßnahmen

Wenn Sie eine Fehlermeldung über eine Anforderung erhalten, die mit einem ungültigen Tokenfehler nicht erfolgreich war, stellen Sie sicher, dass Sie nicht nur den API-Schlüssel eingefügt haben und die vorangehende Tokenzeichenfolge gefolgt ist, ein Leerzeichen und dann Ihr API-Schlüssel.

Wenn beim Erstellen eines Bundles eine Fehlermeldung zu einer ungültigen Eingabe angezeigt wird, stellen Sie sicher, dass es sich um gültige JSON handelt, die an Blueink gesendet wird.

Häufig gestellte Fragen

1. Was ist Blueink?

  • Blueink ist eine erweiterte eSignature-Lösung, die den Dokumentsignaturprozess vereinfacht, wodurch es einfach ist, elektronische Dokumente sicher zu senden, zu signieren und zu verwalten.

2. Was ist der Microsoft Connector für Blueink?

  • Der Microsoft Connector für Blueink ist ein Tool, mit dem Benutzer die eSignature-Lösung von Blueink nahtlos in Microsoft Power Automate integrieren und automatisierungs- und erweiterte Dokumentverwaltung ermöglichen können.

3. Wie funktioniert der Microsoft Connector für Blueink?

  • Mit dem Connector können Sie automatisierte Workflows erstellen, indem Sie Blueink mit anderen Power Automate-Connectors kombinieren. Sie können die Erstellung und Verteilung von Dokumentpaketen automatisieren und Ihre Dokumentverwaltungsprozesse verbessern.

4. Welche Anwendungsfälle gibt es für den Microsoft Connector für Blueink?

  • Häufig verwendete Anwendungsfälle umfassen die Automatisierung von Vertragsgenehmigungen, das Verwalten rechtlicher Dokumente, das Optimieren von Papierarbeitsprozessen und die Sicherstellung einer reibungslosen und effizienten Dokumentsignierung für Kunden und Projektbeteiligte.

5. Kann ich microsoft Connector für Blueink mit anderen Microsoft-Produkten verwenden?

  • Ja, der Connector ist so konzipiert, dass er nahtlos mit verschiedenen Microsoft-Produkten und -Diensten zusammenarbeitet, sodass Sie Blueink eSignatures in Ihre microsoft-zentrierten Workflows integrieren können.

6. Ist microsoft Connector für Blueink einfach einzurichten und zu verwenden?

  • Ja, es ist benutzerfreundlich und darauf ausgelegt, einfach zu sein. Sie können Ihre Workflows entsprechend Ihren spezifischen Dokumentverwaltungsanforderungen konfigurieren und anpassen.

7. Gibt es Kosten für die Verwendung von Microsoft Connector für Blueink?

  • Die Preise können je nach Nutzungs- und Lizenzvereinbarung variieren. Es empfiehlt sich, mit Blueink oder Microsoft nach bestimmten Preisdetails zu suchen.

8. Kann ich Support für technische Probleme mit dem Microsoft Connector für Blueink erhalten?

  • Ja, Blueink und Microsoft bieten in der Regel Supportressourcen und -dokumentationen an, um technische Probleme oder Fragen zu unterstützen, die Sie möglicherweise zur Nutzung des Connectors haben.

9. Ist der Microsoft Connector für Blueink sowohl mit Windows- als auch mit cloudbasierten Microsoft-Diensten kompatibel?

  • Ja, der Connector ist so konzipiert, dass er sowohl mit lokalen als auch mit cloudbasierten Microsoft-Diensten arbeitet und Flexibilität in Ihren Integrationsoptionen bietet.

10. Wo finde ich weitere Informationen zum Microsoft Connector für Blueink?

  • Weitere Informationen, einschließlich Einrichtungsleitfäden und Dokumentationen, können Sie auf der Blueink-Website besuchen oder die Microsoft Power Automate-Dokumentation zu diesem Connector erkunden.

Erstellen einer Verbindung

Der Connector unterstützt die folgenden Authentifizierungstypen:
Vorgabe Parameter zum Erstellen einer Verbindung. Alle Regionen Nicht teilbar

Vorgabe

Anwendbar: Alle Regionen

Parameter zum Erstellen einer Verbindung.

Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.

Name Typ Description Erforderlich
Blueink-API-Schlüssel securestring Ihr Blueink-API-Schlüssel. Dies kann unter der Registerkarte "API" in Blueink erstellt werden. Das richtige Format ist "Token XXXXXX", wobei XXXXXX Ihr API-Schlüssel ist. Richtig

Drosselungsgrenzwerte

Name Aufrufe Verlängerungszeitraum
API-Aufrufe pro Verbindung 100 60 Sekunden

Aktionen

Abbrechen eines Bündels

Abbrechen des durch den Bundle Slug angegebenen Bundles
Abrufen des freigegebenen Geheimen Webhook-Schlüssels

Abrufen des freigegebenen Geheimen Webhook-Schlüssels
Abrufen des Paketzertifikats für Nachweise

Link und Prüfsumme des Nachweiszertifikats für dieses Paket abrufen
Abrufen einer Dokumentvorlage

Abrufen einer Dokumentvorlage
Abrufen einer Person

Abrufen einer Person nach ID
Abrufen eines Bundles

Abrufen eines Bundles durch Schrägstrich
Abrufen eines WebhookExtraHeader

Abrufen der Details eines WebhookExtraHeader
Abrufen eines Webhooks

Abrufen eines Webhooks nach ID
Abrufen von Bundledateien

Abrufen herunterladbarer Dateien für ein abgeschlossenes Bundle
Aktualisieren einer Person

Aktualisieren Sie die Person mit neuen Daten. Beachten Sie, dass alle Kontaktkanäle, die von dieser Anforderung weggelassen werden, GELÖSCHT werden. Wenn Sie nicht alle Daten der Person ersetzen möchten, möchten Sie stattdessen PATCH verwenden.
Aktualisieren eines Pakets

Aktualisieren eines Pakets (auch als Signierer bezeichnet) mit einer neuen E-Mail, Telefonnummer, Namen oder Authentifizierungsoptionen

Das aktualisierte Paket muss weiterhin lieferumfangfähig sein. Wenn Sie z. B. einen deliver_via Wert von "phone" angeben, aber in der ursprünglichen PacketRequest keine Telefonnummer festgelegt wurde, muss diese Anforderung ebenfalls enthalten phone sein, oder ein Fehler wird zurückgegeben.

Sie können ein Paket ändern, das ursprünglich für die eingebettete Signatur konfiguriert wurde (d. h. deliver_via "Embed" war), um per E-Mail oder SMS zugestellt zu werden. Es werden jedoch keine Signaturbenachrichtigungen oder Erinnerungen automatisch gesendet. Sie müssen /packet/{packetId}/remind/ aufrufen, um eine Signaturbenachrichtigungs-E-Mail (oder SMS) zu senden.

Wenn dieser Signierer einer Person zugeordnet ist, wird die Person ebenfalls aktualisiert – der Name der Person wird geändert (sofern angegeben), und alle neuen E-Mails oder Telefonnummern werden hinzugefügt.
Aktualisieren eines WebhookExtraHeader

Aktualisieren des WebhookExtraHeader mit neuen Daten
Aktualisieren eines Webhooks

Aktualisieren Sie den Webhook mit neuen Daten. Beachten Sie, dass alle Abonnements, die aus dieser Anforderung weggelassen werden, GELÖSCHT werden. Wenn Sie nicht alle Daten im Webhook ersetzen möchten, sollten Sie stattdessen PATCH verwenden.
Auflisten von Bundleereignissen

Abrufen einer Liste von Ereignissen, die dem Bundle zugeordnet sind
Auflisten von Paketen

Gibt eine paginierte Liste von Bundles in Ihrem Konto zurück, sortiert nach Erstellungsdatum (von der letzten bis zur letzten Version). Paginierung kann über Paginierungsparameter gesteuert werden (siehe Übersicht-Paginierung>). Abfragezeichenfolgenfilter können kombiniert werden, z. B. /bundles/?search=Gibbons&status__in=se,co&tag=needs-attention. Beim Kombinieren von Filtern werden nur Bundles zurückgegeben, die allen Filtern entsprechen.
Auflisten von Webhooks

Auflisten aller Webhooks in Ihrem BlueInk-Konto
Bündeldaten abrufen

Abrufen von Daten, die in Felder für ein abgeschlossenes Bundle eingegeben wurden
Entfernen von Tags aus einem Bündel

Entfernen von Tags aus einem Bundle. Wenn ein Tag in der Anforderung im Bundle nicht vorhanden ist, wird es ignoriert.
Erinnerung senden

Senden Sie eine Erinnerungs-E-Mail oder SMS an einen Signierer. Eine Erinnerung kann nur einmal pro Stunde gesendet werden. Die Erinnerung wird über die Übermittlungsmethode (E-Mail oder SMS) und an die zuvor für dieses Paket festgelegte E-Mail-Adresse (oder Telefonnummer) gesendet.
Erstellen einer eingebetteten Signatur-URL

Erstellen einer URL, die für die eingebettete Signatur verwendet werden kann
Erstellen einer Person

Erstellen Sie eine neue Person. Eine Person kann einem BlueInk-Benutzer zugeordnet werden oder eine eigenständige Person sein. Wenn Sie eine Person erstellen möchten, die einem BlueInk-Benutzer zugeordnet ist, müssen Sie das user_id Feld angeben. Wenn Sie eine eigenständige Person erstellen möchten, müssen Sie das name Feld angeben.
Erstellen eines Bündels

Erstellen und Senden eines Bundles für die Signatur
Erstellen eines WebhookExtraHeader

Erstellen eines neuen Webhook-Headers
Erstellen eines Webhooks

Erstellen eines neuen Webhooks
Generieren eines freigegebenen geheimen Webhook-Schlüssels

Generieren des freigegebenen geheimen Webhook-Schlüssels
Hinzufügen von Tags zu einem Bündel

Fügen Sie einem Bundle zusätzliche Tags hinzu. Es werden keine vorhandenen Tags im Bundle entfernt. Das Ergebnis dieses Aufrufs ist, dass Bundle.tags die Union der Gruppe früherer Tags mit dem Satz neuer Tags ist. Doppelte Tags werden ignoriert.
Listendokumentvorlagen

Alle Dokumentvorlagen auflisten
Löschen einer Person

Löschen einer Person. Dadurch werden auch alle zugeordneten BlueInk-Benutzer gelöscht.
Löschen eines WebhookExtraHeader

Löschen eines WebhookExtraHeader
Löschen eines Webhooks

Löschen eines Webhooks nach ID
Personen auflisten

Rufen Sie eine Liste der Personen in Ihrem Konto ab. Sie können die Liste optional filtern, indem Sie eine Suchabfrage angeben. Um beispielsweise nach allen Personen mit dem Namen "John" zu suchen, würden Sie die Abfrage search=Johnverwenden.
Teilweises Aktualisieren einer Person

Teilweise aktualisieren Sie die Person mit neuen Daten.

Wenn Sie der Person eine neue E-Mail oder ein neues Telefon hinzufügen möchten, fügen Sie einen ContactChannel in das Array "Kanäle" ohne "ID" ein.

Um einen vorhandenen ContactChannel zu aktualisieren, der der Person zugeordnet ist, fügen Sie eine "ID" ein. Diese vorhandene ContactChannel wird mit der neuen E-Mail oder dem neuen Telefon aktualisiert. Dadurch werden alle Live-Bundles aktualisiert, die der Person zugeordnet sind, die an diese E-Mail (oder das Telefon) gesendet wird.

Wenn ein ContactChannel keine "ID" enthält, aber die E-Mail (oder das Telefon) mit einem vorhandenen ContactChannel übereinstimmt, wird contactChannel nicht geändert.
Teilweises Aktualisieren eines WebhookExtraHeader

WebhookExtraHeader wird teilweise mit neuen Daten aktualisiert.
Teilweises Aktualisieren eines Webhooks

Webhook teilweise mit neuen Daten aktualisieren.
WebhookEvents auflisten

Alle Webhook-Ereignisse in Ihrem BlueInk-Konto auflisten
WebhookEvents auflisten

Auflisten aller WebhookDeliveries in Ihrem BlueInk-Konto
WebhookExtraHeaders auflisten

Auflisten aller WebhookExtraHeaders in Ihrem BlueInk-Konto

Abbrechen eines Bündels

Vorgangs-ID:
cancelBundle

Abbrechen des durch den Bundle Slug angegebenen Bundles

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bündelschrägstrich
 bundleSlug True string

Der Strich, der das Bundle eindeutig identifiziert

Abrufen des freigegebenen Geheimen Webhook-Schlüssels

Vorgangs-ID:
getWebhookSecret

Abrufen des freigegebenen Geheimen Webhook-Schlüssels

Gibt zurück

Name Pfad Typ Beschreibung
create_date
 create_date date-time
secret
 secret b58

Abrufen des Paketzertifikats für Nachweise

Vorgangs-ID:
getPacketCOE

Link und Prüfsumme des Nachweiszertifikats für dieses Paket abrufen

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Paketschrägstrich
 packetId True string

Der Strich, der das Paket eindeutig identifiziert

Abrufen einer Dokumentvorlage

Vorgangs-ID:
retrieveTemplate

Abrufen einer Dokumentvorlage

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Vorlagen-ID
 templateId True uuid

Die ID, die die Vorlage eindeutig identifiziert

Gibt zurück

Name Pfad Typ Beschreibung
fields
 fields array of

Ein Array von Feldern, die im Dokument platziert werden. Beachten Sie, dass DocumentTemplate-Felder geringfügig von DocumentRequest-Feldern abweichen, wobei anstelle default_valueeditor_roles und initial_valueeditors nicht.
file_url
 file_url string

Die URL der ursprünglichen Datei, die als Grundlage für diese Vorlage dient
is_shared
 is_shared boolean

True, wenn die Dokumentvorlage freigegeben ist. Andernfalls falsch
name
 name string

Der Name des Dokuments. Der Standardwert ist der Dateiname oder das Dokument, wenn es hochgeladen wurde, kann jedoch auf einen benutzerfreundlichen Namen festgelegt werden.
roles
 roles array of object
key
 roles.key string

Eine für dieses Dokument eindeutige Zeichenfolge, die diese Rolle identifiziert
label
 roles.label string

Eine benutzerfreundliche Bezeichnung für diese Rolle

Abrufen einer Person

Vorgangs-ID:
getPerson

Abrufen einer Person nach ID

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Personen-ID
 personId True uuid

Die ID, die die Person eindeutig identifiziert

Gibt zurück

Name Pfad Typ Beschreibung
Kanäle
 channels array of object
E-Mail
 channels.email email
id
 channels.id uuid
freundlich
 channels.kind string

em für E-Mail. mp für Telefon.
phone
 channels.phone phone
id
 id uuid
is_user
 is_user boolean

True, wenn diese Person einem BlueInk-Benutzer zugeordnet ist
metadata
 metadata object

Metadaten, die dieser Person zugeordnet werden sollen. Metadaten können in SmartFill verwendet werden, um Dokumente automatisch aufzufüllen. Ausführliche Informationen finden Sie in der SmartFill-Dokumentation.
name
 name string

Der Name der Person

Abrufen eines Bundles

Vorgangs-ID:
retrieveBundle

Abrufen eines Bundles durch Schrägstrich

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bündelschrägstrich
 bundleSlug True string

Der Strich, der das Bundle eindeutig identifiziert

Abrufen eines WebhookExtraHeader

Vorgangs-ID:
getWebhookExtraHeader

Abrufen der Details eines WebhookExtraHeader

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
WebhookExtraHeader-ID
 webhookExtraHeaderId True uuid

Die ID, die den WebhookExtraHeader eindeutig identifiziert

Gibt zurück

Name Pfad Typ Beschreibung
id
 id uuid
name
 name string

muss RFC 7230 einhalten
order
 order integer
value
 value string

muss RFC 7230 einhalten
Webhook
 webhook uuid

Abrufen eines Webhooks

Vorgangs-ID:
getWebhook

Abrufen eines Webhooks nach ID

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Webhook-ID
 webhookId True uuid

Die ID, die den Webhook eindeutig identifiziert

Gibt zurück

Name Pfad Typ Beschreibung
enabled
 enabled boolean
event_types
 event_types array of string

Ereignistypen, die den Webhook auslösen
extra_headers
 extra_headers array of object
id
 extra_headers.id uuid
name
 extra_headers.name string

muss RFC 7230 einhalten
order
 extra_headers.order integer
value
 extra_headers.value string

muss RFC 7230 einhalten
Webhook
 extra_headers.webhook uuid
id
 id uuid
json
 json boolean
URL
 url url

sollte die vollständige URL sein, einschließlich http/https

Abrufen von Bundledateien

Vorgangs-ID:
getBundleFiles

Abrufen herunterladbarer Dateien für ein abgeschlossenes Bundle

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bündelschrägstrich
 bundleSlug True string

Der Strich, der das Bundle eindeutig identifiziert

Gibt zurück

Name Pfad Typ Beschreibung
array of object
Abläuft
 expires string

Die Uhrzeit, zu der der Link abläuft, als iso 8601 formatierte Zeit
file_url
 file_url string

die URL, von der die Datei heruntergeladen werden kann

Aktualisieren einer Person

Vorgangs-ID:
updatePerson

Aktualisieren Sie die Person mit neuen Daten. Beachten Sie, dass alle Kontaktkanäle, die von dieser Anforderung weggelassen werden, GELÖSCHT werden. Wenn Sie nicht alle Daten der Person ersetzen möchten, möchten Sie stattdessen PATCH verwenden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Personen-ID
 personId True uuid

Die ID, die die Person eindeutig identifiziert
E-Mail
 email email
id
 id uuid
freundlich
 kind string

em für E-Mail. mp für Telefon.
phone
 phone phone
id
 id uuid
is_user
 is_user boolean

True, wenn diese Person einem BlueInk-Benutzer zugeordnet ist
metadata
 metadata object

Metadaten, die dieser Person zugeordnet werden sollen. Metadaten können in SmartFill verwendet werden, um Dokumente automatisch aufzufüllen. Ausführliche Informationen finden Sie in der SmartFill-Dokumentation.
name
 name string

Der Name der Person

Gibt zurück

Name Pfad Typ Beschreibung
Kanäle
 channels array of object
E-Mail
 channels.email email
id
 channels.id uuid
freundlich
 channels.kind string

em für E-Mail. mp für Telefon.
phone
 channels.phone phone
id
 id uuid
is_user
 is_user boolean

True, wenn diese Person einem BlueInk-Benutzer zugeordnet ist
metadata
 metadata object

Metadaten, die dieser Person zugeordnet werden sollen. Metadaten können in SmartFill verwendet werden, um Dokumente automatisch aufzufüllen. Ausführliche Informationen finden Sie in der SmartFill-Dokumentation.
name
 name string

Der Name der Person

Aktualisieren eines Pakets

Vorgangs-ID:
updatePacket

Aktualisieren eines Pakets (auch als Signierer bezeichnet) mit einer neuen E-Mail, Telefonnummer, Namen oder Authentifizierungsoptionen

Das aktualisierte Paket muss weiterhin lieferumfangfähig sein. Wenn Sie z. B. einen deliver_via Wert von "phone" angeben, aber in der ursprünglichen PacketRequest keine Telefonnummer festgelegt wurde, muss diese Anforderung ebenfalls enthalten phone sein, oder ein Fehler wird zurückgegeben.

Sie können ein Paket ändern, das ursprünglich für die eingebettete Signatur konfiguriert wurde (d. h. deliver_via "Embed" war), um per E-Mail oder SMS zugestellt zu werden. Es werden jedoch keine Signaturbenachrichtigungen oder Erinnerungen automatisch gesendet. Sie müssen /packet/{packetId}/remind/ aufrufen, um eine Signaturbenachrichtigungs-E-Mail (oder SMS) zu senden.

Wenn dieser Signierer einer Person zugeordnet ist, wird die Person ebenfalls aktualisiert – der Name der Person wird geändert (sofern angegeben), und alle neuen E-Mails oder Telefonnummern werden hinzugefügt.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Paketschrägstrich
 packetId True string

Der Strich, der das Paket eindeutig identifiziert
body
 body

Aktualisieren eines WebhookExtraHeader

Vorgangs-ID:
updateWebhookExtraHeader

Aktualisieren des WebhookExtraHeader mit neuen Daten

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
WebhookExtraHeader-ID
 webhookExtraHeaderId True uuid

Die ID, die den WebhookExtraHeader eindeutig identifiziert
id
 id uuid
name
 name string

muss RFC 7230 einhalten
order
 order integer
value
 value string

muss RFC 7230 einhalten
Webhook
 webhook uuid

Gibt zurück

Name Pfad Typ Beschreibung
id
 id uuid
name
 name string

muss RFC 7230 einhalten
order
 order integer
value
 value string

muss RFC 7230 einhalten
Webhook
 webhook uuid

Aktualisieren eines Webhooks

Vorgangs-ID:
updateWebhook

Aktualisieren Sie den Webhook mit neuen Daten. Beachten Sie, dass alle Abonnements, die aus dieser Anforderung weggelassen werden, GELÖSCHT werden. Wenn Sie nicht alle Daten im Webhook ersetzen möchten, sollten Sie stattdessen PATCH verwenden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Webhook-ID
 webhookId True uuid

Die ID, die den Webhook eindeutig identifiziert
enabled
 enabled boolean
event_types
 event_types array of string

Ereignistypen, die den Webhook auslösen
id
 id uuid
name
 name string

muss RFC 7230 einhalten
order
 order integer
value
 value string

muss RFC 7230 einhalten
Webhook
 webhook uuid
id
 id uuid
json
 json boolean
URL
 url url

sollte die vollständige URL sein, einschließlich http/https

Gibt zurück

Name Pfad Typ Beschreibung
enabled
 enabled boolean
event_types
 event_types array of string

Ereignistypen, die den Webhook auslösen
extra_headers
 extra_headers array of object
id
 extra_headers.id uuid
name
 extra_headers.name string

muss RFC 7230 einhalten
order
 extra_headers.order integer
value
 extra_headers.value string

muss RFC 7230 einhalten
Webhook
 extra_headers.webhook uuid
id
 id uuid
json
 json boolean
URL
 url url

sollte die vollständige URL sein, einschließlich http/https

Auflisten von Bundleereignissen

Vorgangs-ID:
listBundleEvents

Abrufen einer Liste von Ereignissen, die dem Bundle zugeordnet sind

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bündelschrägstrich
 bundleSlug True string

Der Strich, der das Bundle eindeutig identifiziert

Gibt zurück

Name Pfad Typ Beschreibung
array of object
Beschreibung
 description string

Eine kurze Abbruch des Ereignisses
freundlich
 kind string

Die Art des Ereignisses als 2-Zeichen-Code
packet_id
 packet_id uuid

Die UUID eines Pakets. Nur vorhanden, wenn das Ereignis einem bestimmten Paket zugeordnet ist.
Zeitstempel
 timestamp date-time

Der Zeitpunkt, zu dem das Ereignis aufgetreten ist

Auflisten von Paketen

Vorgangs-ID:
listBundles

Gibt eine paginierte Liste von Bundles in Ihrem Konto zurück, sortiert nach Erstellungsdatum (von der letzten bis zur letzten Version). Paginierung kann über Paginierungsparameter gesteuert werden (siehe Übersicht-Paginierung>). Abfragezeichenfolgenfilter können kombiniert werden, z. B. /bundles/?search=Gibbons&status__in=se,co&tag=needs-attention. Beim Kombinieren von Filtern werden nur Bundles zurückgegeben, die allen Filtern entsprechen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Suchabfrage
 search string

Eine Suchabfrage. Es werden nur Bündel zurückgegeben, die der Suche entsprechen. Die folgenden Daten im Bundle werden durchsucht:

  • Bündelschrägstrich
  • Bündeletikett
  • bundle custom_key
  • Signierername
  • E-Mail-Adresse des Signierers
  • Signiertelefone

Beispiel: /bundles/?search=foobar@example.com
Bundlestatus
 status string

Beschränken Sie Bündel auf diejenigen mit dem angegebenen Status.

  • dr: Entwurf - das Bundle wurde noch nicht gesendet
  • se: Gesendet - das Bundle wurde gesendet, aber noch nicht von Signierern gestartet
  • st: Gestartet – mindestens ein Signierer hat begonnen, das Dokument(n) zu überprüfen.
  • co: Abgeschlossen - alle Signierer haben die Überprüfung /Signierung abgeschlossen
  • ca: Abgebrochen – das Bundle wurde abgebrochen.
  • ex: Abgelaufen – das Bundle ist abgelaufen, bevor es abgeschlossen war
  • fa: Fehlgeschlagen – Fehler, und das Bundle konnte nicht erstellt oder abgeschlossen werden.

Beispiel: /bundles/?status=co
Liste des Bundlestatus
 status__in string

Beschränken Sie Bündel auf diejenigen mit einem der angegebenen Status. Status müssen durch Kommas getrennt werden. Beispiel: /bundles/?status=co,se,st
Bundle-Tag
 tag string

Gibt Bundles zurück, die das angegebene Tag aufweisen. Beispiel: /bundles/?tag=some-tag
Liste der Bundle-Tags
 tag__in string

Gibt Bundles zurück, die mindestens einen der angegebenen Tags enthalten. Tags sollten durch Trennzeichen getrennt werden. Beispiel: /bundles/?tag=some-tag,another-tag
Sortierreihenfolge des Bündels
 ordering string

Steuern sie die Sortierreihenfolge von Bundles. Präfix mit "-", um die Sortierreihenfolge umzukehren. Standardmäßig werden Bundles nach "-created" sortiert, also nach dem Erstellungsdatum des Bundles von der höchsten bis zur letzten.

Gibt zurück

Name Pfad Typ Beschreibung
array of

Auflisten von Webhooks

Vorgangs-ID:
listWebhooks

Auflisten aller Webhooks in Ihrem BlueInk-Konto

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Enabled
 enabled boolean

Nur Webhooks, die mit dem ausgewählten Status "aktiviert" übereinstimmen, werden zurückgegeben.

Beispiel: /webhooks/?enabled=true
Ereignistyp
 event_type string

Nur Webhooks, die dem ausgewählten event_type oder event_types entsprechen, werden zurückgegeben.

Z.B. /webhooks/?event_type=bundle_sent/webhooks/?event_type__in=bundle_error,bundle_cancelled

Gibt zurück

Name Pfad Typ Beschreibung
array of object
enabled
 enabled boolean
event_types
 event_types array of string

Ereignistypen, die den Webhook auslösen
extra_headers
 extra_headers array of object
id
 extra_headers.id uuid
name
 extra_headers.name string

muss RFC 7230 einhalten
order
 extra_headers.order integer
value
 extra_headers.value string

muss RFC 7230 einhalten
Webhook
 extra_headers.webhook uuid
id
 id uuid
json
 json boolean
URL
 url url

sollte die vollständige URL sein, einschließlich http/https

Bündeldaten abrufen

Vorgangs-ID:
getBundleData

Abrufen von Daten, die in Felder für ein abgeschlossenes Bundle eingegeben wurden

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bündelschrägstrich
 bundleSlug True string

Der Strich, der das Bundle eindeutig identifiziert

Gibt zurück

Name Pfad Typ Beschreibung
array of object
attachments
 attachments array of object

Ein Array von Dateianlagen für ein Anlagefeld oder null
Extern
 attachments.ext string

Die Dateierweiterung
is_image
 attachments.is_image boolean

true, wenn es sich bei dieser Anlagendatei um ein Bild handelt
name
 attachments.name string

Dateiname der Anlage
Num
 attachments.num integer

Die Reihenfolge, in der die Datei hinzugefügt wurde, wenn es mehrere Uploads für ein einzelnes Anlagenfeld gibt (z. B. ein Foto für jede Seite eines Dokuments, die mit einer Webcam aufgenommen wurde)
size
 attachments.size integer

Größe der Datei in Byte
URL
 attachments.url url

Eine URL, die vorübergehend zum Herunterladen der Anlagendatei verwendet werden kann
doc_key
 doc_key string

Der Schlüssel, der dieses Dokument im Bundle eindeutig identifiziert (aus dem ursprünglichen BundleRequest)
field_key
 field_key string

Der Schlüssel, der das Feld im Dokument eindeutig identifiziert (entweder wie im ursprünglichen DocumentRequestField in der DocumentRequest in BundleRequest angegeben, oder wie in der DocumentTemplate konfiguriert)
filled_by
 filled_by string

Der Paketschlüssel des Signierers, der den Wert für dieses Feld eingegeben hat. Wenn der Feldwert ein "initial_value" war, der nicht von einem Signierer bearbeitet wurde, lautet der Wert "initial". Wenn der Feldwert der Standardwert war, der in einer DocumentTemplate konfiguriert wurde, lautet der Füllbereich "default".
freundlich
 kind string

Die Art des Felds
label
 label string

Die Beschriftung des Felds (möglicherweise leer)
packet_id
 packet_id

Die Paket-ID des Signierers, der den Wert für dieses Feld eingegeben hat, oder NULL, wenn der Feldwert nicht von einem Signierer ausgefüllt wurde (d. h. ein initial_value- oder Defaulwert).
value
 value

Der Wert des -Felds.

Entfernen von Tags aus einem Bündel

Vorgangs-ID:
removeBundleTags

Entfernen von Tags aus einem Bundle. Wenn ein Tag in der Anforderung im Bundle nicht vorhanden ist, wird es ignoriert.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bündelschrägstrich
 bundleSlug True string

Der Strich, der das Bundle eindeutig identifiziert
tags
 tags array of string

Ein Array von Tags

Erinnerung senden

Vorgangs-ID:
sendPacketReminder

Senden Sie eine Erinnerungs-E-Mail oder SMS an einen Signierer. Eine Erinnerung kann nur einmal pro Stunde gesendet werden. Die Erinnerung wird über die Übermittlungsmethode (E-Mail oder SMS) und an die zuvor für dieses Paket festgelegte E-Mail-Adresse (oder Telefonnummer) gesendet.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Paketschrägstrich
 packetId True string

Der Strich, der das Paket eindeutig identifiziert

Erstellen einer eingebetteten Signatur-URL

Vorgangs-ID:
createPacketEmbedURL

Erstellen einer URL, die für die eingebettete Signatur verwendet werden kann

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Paketschrägstrich
 packetId True string

Der Strich, der das Paket eindeutig identifiziert

Gibt zurück

Name Pfad Typ Beschreibung
Abläuft
 expires date-time

Zeitstempel, der angibt, wann die URL abläuft
URL
 url string

Die URL, die für die eingebettete Signatur verwendet werden kann

Erstellen einer Person

Vorgangs-ID:
createPerson

Erstellen Sie eine neue Person. Eine Person kann einem BlueInk-Benutzer zugeordnet werden oder eine eigenständige Person sein. Wenn Sie eine Person erstellen möchten, die einem BlueInk-Benutzer zugeordnet ist, müssen Sie das user_id Feld angeben. Wenn Sie eine eigenständige Person erstellen möchten, müssen Sie das name Feld angeben.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
E-Mail
 email email
id
 id uuid
freundlich
 kind string

em für E-Mail. mp für Telefon.
phone
 phone phone
id
 id uuid
is_user
 is_user boolean

True, wenn diese Person einem BlueInk-Benutzer zugeordnet ist
metadata
 metadata object

Metadaten, die dieser Person zugeordnet werden sollen. Metadaten können in SmartFill verwendet werden, um Dokumente automatisch aufzufüllen. Ausführliche Informationen finden Sie in der SmartFill-Dokumentation.
name
 name string

Der Name der Person

Gibt zurück

Name Pfad Typ Beschreibung
Kanäle
 channels array of object
E-Mail
 channels.email email
id
 channels.id uuid
freundlich
 channels.kind string

em für E-Mail. mp für Telefon.
phone
 channels.phone phone
id
 id uuid
is_user
 is_user boolean

True, wenn diese Person einem BlueInk-Benutzer zugeordnet ist
metadata
 metadata object

Metadaten, die dieser Person zugeordnet werden sollen. Metadaten können in SmartFill verwendet werden, um Dokumente automatisch aufzufüllen. Ausführliche Informationen finden Sie in der SmartFill-Dokumentation.
name
 name string

Der Name der Person

Erstellen eines Bündels

Vorgangs-ID:
createBundle

Erstellen und Senden eines Bundles für die Signatur

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
body
 body

Der JSON-Textkörper, der das zu erstellende Bundle definiert

Erstellen eines WebhookExtraHeader

Vorgangs-ID:
createWebhookExtraHeader

Erstellen eines neuen Webhook-Headers

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
id
 id uuid
name
 name string

muss RFC 7230 einhalten
order
 order integer
value
 value string

muss RFC 7230 einhalten
Webhook
 webhook uuid

Gibt zurück

Name Pfad Typ Beschreibung
id
 id uuid
name
 name string

muss RFC 7230 einhalten
order
 order integer
value
 value string

muss RFC 7230 einhalten
Webhook
 webhook uuid

Erstellen eines Webhooks

Vorgangs-ID:
createWebhook

Erstellen eines neuen Webhooks

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
enabled
 enabled boolean
event_types
 event_types array of string

Ereignistypen, die den Webhook auslösen
id
 id uuid
name
 name string

muss RFC 7230 einhalten
order
 order integer
value
 value string

muss RFC 7230 einhalten
Webhook
 webhook uuid
id
 id uuid
json
 json boolean
URL
 url url

sollte die vollständige URL sein, einschließlich http/https

Gibt zurück

Name Pfad Typ Beschreibung
enabled
 enabled boolean
event_types
 event_types array of string

Ereignistypen, die den Webhook auslösen
extra_headers
 extra_headers array of object
id
 extra_headers.id uuid
name
 extra_headers.name string

muss RFC 7230 einhalten
order
 extra_headers.order integer
value
 extra_headers.value string

muss RFC 7230 einhalten
Webhook
 extra_headers.webhook uuid
id
 id uuid
json
 json boolean
URL
 url url

sollte die vollständige URL sein, einschließlich http/https

Generieren eines freigegebenen geheimen Webhook-Schlüssels

Vorgangs-ID:
regenerateWebhookSecret

Generieren des freigegebenen geheimen Webhook-Schlüssels

Gibt zurück

Name Pfad Typ Beschreibung
create_date
 create_date date-time
secret
 secret b58

Hinzufügen von Tags zu einem Bündel

Vorgangs-ID:
addBundleTags

Fügen Sie einem Bundle zusätzliche Tags hinzu. Es werden keine vorhandenen Tags im Bundle entfernt. Das Ergebnis dieses Aufrufs ist, dass Bundle.tags die Union der Gruppe früherer Tags mit dem Satz neuer Tags ist. Doppelte Tags werden ignoriert.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bündelschrägstrich
 bundleSlug True string

Der Strich, der das Bundle eindeutig identifiziert
tags
 tags array of string

Ein Array von Tags

Listendokumentvorlagen

Vorgangs-ID:
listTemplates

Alle Dokumentvorlagen auflisten

Gibt zurück

Name Pfad Typ Beschreibung
fields
 fields array of

Ein Array von Feldern, die im Dokument platziert werden. Beachten Sie, dass DocumentTemplate-Felder geringfügig von DocumentRequest-Feldern abweichen, wobei anstelle default_valueeditor_roles und initial_valueeditors nicht.
file_url
 file_url string

Die URL der ursprünglichen Datei, die als Grundlage für diese Vorlage dient
is_shared
 is_shared boolean

True, wenn die Dokumentvorlage freigegeben ist. Andernfalls falsch
name
 name string

Der Name des Dokuments. Der Standardwert ist der Dateiname oder das Dokument, wenn es hochgeladen wurde, kann jedoch auf einen benutzerfreundlichen Namen festgelegt werden.
roles
 roles array of object
key
 roles.key string

Eine für dieses Dokument eindeutige Zeichenfolge, die diese Rolle identifiziert
label
 roles.label string

Eine benutzerfreundliche Bezeichnung für diese Rolle

Löschen einer Person

Vorgangs-ID:
deletePerson

Löschen einer Person. Dadurch werden auch alle zugeordneten BlueInk-Benutzer gelöscht.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Personen-ID
 personId True uuid

Die ID, die die Person eindeutig identifiziert

Löschen eines WebhookExtraHeader

Vorgangs-ID:
deleteWebhookExtraHeader

Löschen eines WebhookExtraHeader

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
WebhookExtraHeader-ID
 webhookExtraHeaderId True uuid

Die ID, die den WebhookExtraHeader eindeutig identifiziert

Löschen eines Webhooks

Vorgangs-ID:
deleteWebhook

Löschen eines Webhooks nach ID

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Webhook-ID
 webhookId True uuid

Die ID, die den Webhook eindeutig identifiziert

Personen auflisten

Vorgangs-ID:
listPersons

Rufen Sie eine Liste der Personen in Ihrem Konto ab. Sie können die Liste optional filtern, indem Sie eine Suchabfrage angeben. Um beispielsweise nach allen Personen mit dem Namen "John" zu suchen, würden Sie die Abfrage search=Johnverwenden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Suchabfrage
 search string

Eine Suchabfrage.

Gibt zurück

Name Pfad Typ Beschreibung
array of object
Kanäle
 channels array of object
E-Mail
 channels.email email
id
 channels.id uuid
freundlich
 channels.kind string

em für E-Mail. mp für Telefon.
phone
 channels.phone phone
id
 id uuid
is_user
 is_user boolean

True, wenn diese Person einem BlueInk-Benutzer zugeordnet ist
metadata
 metadata object

Metadaten, die dieser Person zugeordnet werden sollen. Metadaten können in SmartFill verwendet werden, um Dokumente automatisch aufzufüllen. Ausführliche Informationen finden Sie in der SmartFill-Dokumentation.
name
 name string

Der Name der Person

Teilweises Aktualisieren einer Person

Vorgangs-ID:
updatePersonPartial

Teilweise aktualisieren Sie die Person mit neuen Daten.

Wenn Sie der Person eine neue E-Mail oder ein neues Telefon hinzufügen möchten, fügen Sie einen ContactChannel in das Array "Kanäle" ohne "ID" ein.

Um einen vorhandenen ContactChannel zu aktualisieren, der der Person zugeordnet ist, fügen Sie eine "ID" ein. Diese vorhandene ContactChannel wird mit der neuen E-Mail oder dem neuen Telefon aktualisiert. Dadurch werden alle Live-Bundles aktualisiert, die der Person zugeordnet sind, die an diese E-Mail (oder das Telefon) gesendet wird.

Wenn ein ContactChannel keine "ID" enthält, aber die E-Mail (oder das Telefon) mit einem vorhandenen ContactChannel übereinstimmt, wird contactChannel nicht geändert.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Personen-ID
 personId True uuid

Die ID, die die Person eindeutig identifiziert
E-Mail
 email email
id
 id uuid
freundlich
 kind string

em für E-Mail. mp für Telefon.
phone
 phone phone
id
 id uuid
is_user
 is_user boolean

True, wenn diese Person einem BlueInk-Benutzer zugeordnet ist
metadata
 metadata object

Metadaten, die dieser Person zugeordnet werden sollen. Metadaten können in SmartFill verwendet werden, um Dokumente automatisch aufzufüllen. Ausführliche Informationen finden Sie in der SmartFill-Dokumentation.
name
 name string

Der Name der Person

Gibt zurück

Name Pfad Typ Beschreibung
Kanäle
 channels array of object
E-Mail
 channels.email email
id
 channels.id uuid
freundlich
 channels.kind string

em für E-Mail. mp für Telefon.
phone
 channels.phone phone
id
 id uuid
is_user
 is_user boolean

True, wenn diese Person einem BlueInk-Benutzer zugeordnet ist
metadata
 metadata object

Metadaten, die dieser Person zugeordnet werden sollen. Metadaten können in SmartFill verwendet werden, um Dokumente automatisch aufzufüllen. Ausführliche Informationen finden Sie in der SmartFill-Dokumentation.
name
 name string

Der Name der Person

Teilweises Aktualisieren eines WebhookExtraHeader

Vorgangs-ID:
updateWebhookExtraHeaderPartial

WebhookExtraHeader wird teilweise mit neuen Daten aktualisiert.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
WebhookExtraHeader-ID
 webhookExtraHeaderId True uuid

Die ID, die den WebhookExtraHeader eindeutig identifiziert
id
 id uuid
name
 name string

muss RFC 7230 einhalten
order
 order integer
value
 value string

muss RFC 7230 einhalten
Webhook
 webhook uuid

Gibt zurück

Name Pfad Typ Beschreibung
id
 id uuid
name
 name string

muss RFC 7230 einhalten
order
 order integer
value
 value string

muss RFC 7230 einhalten
Webhook
 webhook uuid

Teilweises Aktualisieren eines Webhooks

Vorgangs-ID:
updateWebhookartial

Webhook teilweise mit neuen Daten aktualisieren.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Webhook-ID
 webhookId True uuid

Die ID, die den Webhook eindeutig identifiziert
enabled
 enabled boolean
event_types
 event_types array of string

Ereignistypen, die den Webhook auslösen
id
 id uuid
name
 name string

muss RFC 7230 einhalten
order
 order integer
value
 value string

muss RFC 7230 einhalten
Webhook
 webhook uuid
id
 id uuid
json
 json boolean
URL
 url url

sollte die vollständige URL sein, einschließlich http/https

Gibt zurück

Name Pfad Typ Beschreibung
enabled
 enabled boolean
event_types
 event_types array of string

Ereignistypen, die den Webhook auslösen
extra_headers
 extra_headers array of object
id
 extra_headers.id uuid
name
 extra_headers.name string

muss RFC 7230 einhalten
order
 extra_headers.order integer
value
 extra_headers.value string

muss RFC 7230 einhalten
Webhook
 extra_headers.webhook uuid
id
 id uuid
json
 json boolean
URL
 url url

sollte die vollständige URL sein, einschließlich http/https

WebhookEvents auflisten

Vorgangs-ID:
listWebhookEvents

Alle Webhook-Ereignisse in Ihrem BlueInk-Konto auflisten

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Webhook-ID
 webhook uuid

Nur WebhookEvents, die der ausgewählten Webhook-ID entsprechen, werden zurückgegeben.

Beispiel: /webhooks/events/?webhook=a053644f-e371-4883-ac17-534445993346
Ereignistyp
 event_type string

Nur WebhookEvents mit Webhooks, die dem ausgewählten event_type oder event_types entsprechen, werden zurückgegeben.

Z.B. /webhooks/events/?event_type=bundle_sent/webhooks/events/?event_type__in=bundle_error,bundle_cancelled
Der Status
 status integer

Nur WebhookEvents, die dem ausgewählten Status entsprechen, werden zurückgegeben.

Z.B. /webhooks/events/?status=1/webhooks/events/?status__in=0,1,2
Erfolgsergebnis
 success boolean

Nur WebhookEvents, die dem ausgewählten Erfolgsstatus entsprechen, werden zurückgegeben.

Beispiel: /webhooks/events/?success=true
Datumsbereich
 date date-time

Nur WebhookEvents, die zwischen einem Datumsbereich auftreten, werden zurückgegeben. Hinweis: Datumsangaben werden als JJJJ-MM-DD Format ausgedrückt.

Beispiel: /webhooks/events/?date_after=2022-10-01&date_before=2022-10-31

Gibt zurück

Name Pfad Typ Beschreibung
array of object
erstellt
 created date-time
Lieferungen
 deliveries array of object
message
 deliveries.message string

eine Meldung, die alle Probleme beschreibt
Pk
 deliveries.pk uuid
status
 deliveries.status integer

Statusmeldung der Antwort oder 0, wenn kein Status
Zeitstempel
 deliveries.timestamp date-time

Wenn der Übermittlungsversuch aufgetreten ist (der Start des Versuchs, nicht bei einem Fehler, z. B. für ein Timeout)
event_type
 event_type string
payload
 payload string

die Nutzlast, die an die Lieferung gesendet werden soll; json
Pk
 pk uuid
status
 status integer

der Statuscode der letzten Antwort vom Webhook-Endpunkt. 0 gibt an, dass keine Antwort empfangen wurde
Erfolgreich
 success boolean
Webhook
 webhook uuid

UUID zur Identifizierung, zu welchem Webhook das Ereignis gehört

WebhookEvents auflisten

Vorgangs-ID:
listWebhookDeliveries

Auflisten aller WebhookDeliveries in Ihrem BlueInk-Konto

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Webhook-ID
 webhook uuid

Nur WebhookDeliveries, die der ausgewählten Webhook-ID entsprechen, werden zurückgegeben.

Beispiel: /webhooks/deliveries/?webhook=a053644f-e371-4883-ac17-534445993346
Webhook-Ereignis-ID
 webhook_event uuid

Nur WebhookDeliveries, die der ausgewählten webhook_event-ID entsprechen, werden zurückgegeben.

Beispiel: /webhooks/deliveries/?webhook_event=a053644f-e371-4883-ac17-534445993346
Ereignistyp
 event_type string

Nur WebhookDeliveries mit Webhooks, die dem ausgewählten event_type oder event_types entsprechen, werden zurückgegeben.

Z.B. /webhooks/deliveries/?event_type=bundle_sent/webhooks/deliveries/?event_type__in=bundle_error,bundle_cancelled
Der Status
 status integer

Nur WebhookDeliveries, die dem ausgewählten Status entsprechen, werden zurückgegeben.

Z.B. /webhooks/deliveries/?status=1/webhooks/deliveries/?status__in=0,1,2
Datumsbereich
 date date-time

Es wird nur WebhookDeliveries zurückgegeben, die zwischen einem Datumsbereich auftreten. Hinweis: Datumsangaben werden als JJJJ-MM-DD Format ausgedrückt.

Beispiel: /webhooks/deliveries/?date_after=2022-10-01&date_before=2022-10-31

Gibt zurück

Name Pfad Typ Beschreibung
array of object
erstellt
 created date-time
Lieferungen
 deliveries array of object
message
 deliveries.message string

eine Meldung, die alle Probleme beschreibt
Pk
 deliveries.pk uuid
status
 deliveries.status integer

Statusmeldung der Antwort oder 0, wenn kein Status
Zeitstempel
 deliveries.timestamp date-time

Wenn der Übermittlungsversuch aufgetreten ist (der Start des Versuchs, nicht bei einem Fehler, z. B. für ein Timeout)
event_type
 event_type string
payload
 payload string

die Nutzlast, die an die Lieferung gesendet werden soll; json
Pk
 pk uuid
status
 status integer

der Statuscode der letzten Antwort vom Webhook-Endpunkt. 0 gibt an, dass keine Antwort empfangen wurde
Erfolgreich
 success boolean
Webhook
 webhook uuid

UUID zur Identifizierung, zu welchem Webhook das Ereignis gehört

WebhookExtraHeaders auflisten

Vorgangs-ID:
listWebhookExtraHeaders

Auflisten aller WebhookExtraHeaders in Ihrem BlueInk-Konto

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Webhook-ID
 webhook uuid

Nur WebhookExtraHeaders, die der ausgewählten Webhook-ID entsprechen, werden zurückgegeben.

Beispiel: /webhooks/headers/?webhook=a053644f-e371-4883-ac17-534445993346
Ereignistyp
 event_type string

Nur WebhookExtraHeaders mit Webhooks, die dem ausgewählten event_type oder event_types entsprechen, werden zurückgegeben.

Z.B. /webhooks/headers/?event_type=bundle_sent/webhooks/headers/?event_type__in=bundle_error,bundle_cancelled

Gibt zurück

Name Pfad Typ Beschreibung
array of object
id
 id uuid
name
 name string

muss RFC 7230 einhalten
order
 order integer
value
 value string

muss RFC 7230 einhalten
Webhook
 webhook uuid