Delen via

BlueInk

Met de Blueink-connector kunt u het eSignature-platform van Blueink toevoegen aan geautomatiseerde werkstromen. Met de connector kunt u de bundelstatus controleren, nieuwe bundels maken, toegangsinformatie voor ondertekenaar en meer.

Deze connector is beschikbaar in de volgende producten en regio's:

Dienst Class Regions
Copilot Studio Premium Alle Power Automate-regio's , met uitzondering van het volgende:
     - Amerikaanse overheid (GCC)
     - Amerikaanse overheid (GCC High)
     - China Cloud beheerd door 21Vianet
     - Us Department of Defense (DoD)
Logic-apps Standaard Alle Logic Apps-regio's , met uitzondering van het volgende:
     - Azure Government-regio's
     - Azure China-regio's
     - Us Department of Defense (DoD)
Power Apps Premium Alle Power Apps-regio's , met uitzondering van het volgende:
     - Amerikaanse overheid (GCC)
     - Amerikaanse overheid (GCC High)
     - China Cloud beheerd door 21Vianet
     - Us Department of Defense (DoD)
Power Automate Premium Alle Power Automate-regio's , met uitzondering van het volgende:
     - Amerikaanse overheid (GCC)
     - Amerikaanse overheid (GCC High)
     - China Cloud beheerd door 21Vianet
     - Us Department of Defense (DoD)
Contactpersoon
Naam Ondersteuning voor Blueink
URL https://help.blueink.com/en/
E-mailen support@blueink.com
Connectormetagegevens
Uitgever Blauweink
Webpagina https://blueink.com
Privacybeleid https://blueink.com/privacy-policy/
Categorieën Bedrijfsbeheer; Productiviteit

Met deze veelzijdige connector kunnen gebruikers de krachtige eSignature-oplossing van Blueink naadloos integreren in hun werkstroom door gebruik te maken van de mogelijkheden van verschillende Power Automate-connectors. Dankzij deze integratie kunnen gebruikers het maken en distribueren van documentbundels moeiteloos automatiseren. Door de harmonische interactie van deze connector te organiseren met andere connectors, kunt u uw processen voor documentbeheer stroomlijnen, de efficiëntie verbeteren en een naadloze en efficiënte ervaring voor documentondertekening garanderen voor uw klanten en belanghebbenden. Of het nu gaat om het automatiseren van goedkeuringen van contracten, het verwerken van juridische documenten of het beheren van papierwerk in een andere context, deze connector biedt een krachtig hulpmiddel om uw werkstroom te optimaliseren en de productiviteit te verhogen.

Vereiste voorwaarden

Als u deze connector wilt gebruiken, hebt u een API-account nodig van blueink.com.

Referenties ophalen

Nadat u uw account hebt gemaakt, klikt u aan de linkerkant van de pagina op de API-knop . Druk onder Persoonlijke API-sleutels op de knop API-sleutel toevoegen . Geef de API-sleutel een label en druk op Verzenden. Kopieer de API-sleutel en sla deze ergens op, omdat deze niet opnieuw wordt weergegeven.

Aan de slag met uw connector

Wanneer u voor het eerst een Blueink-verbinding maakt, wordt u gevraagd een API-sleutel in te voeren. Uw API-sleutel moet altijd beginnen met token , gevolgd door een spatie en vervolgens de API-sleutel die u hebt gemaakt. Het invoeren van uw API-sleutel moet eruitzien als deze token-API-SLEUTEL<>.

Een populaire actie is het maken van een bundel. Voor het maken van een bundel is een complexe set invoer vereist. Bekijk onze API-documentatie https://blueink.com/esignature-api/api-docs/#tag/Bundles/operation/createBundle over hoe de hoofdtekstvariabele eruit kan zien. Afbeelding hieronder als voorbeeld van een hoofdtekst voor het maken van een bundel.

Een bundel maken

Er zijn meerdere manieren om een bundel te maken en u kunt deze JSON aanpassen aan de bundel die u wilt maken. Bekijk de API voor meer manieren waarop deze JSON kan worden gewijzigd. Deze maakt gebruik van een eerder gemaakte sjabloon die de gebruiker in zijn account heeft ingesteld.

Het vermelden van alle voltooide bundels is een ander populair eindpunt. Voeg de actie Lijstbundels toe en wijzig vervolgens de statusknop in co voor voltooide bundels. Met dit eindpunt kunt u up-to-date blijven met al uw meest recente voltooide bundels.

Bundels weergeven

Bekende problemen en beperkingen

Er is een hoofdtekst-JSON vereist voor het eindpunt voor het maken van bundels

Veelvoorkomende fouten en oplossingen

Als er een fout optreedt over een aanvraag die niet slaagt met een ongeldige tokenfout, moet u ervoor zorgen dat u de API-sleutel niet alleen hebt geplakt en dat de voorgaande tokentekenreeks een spatie is gevolgd en vervolgens uw API-sleutel.

Als er een foutbericht wordt weergegeven over een ongeldige invoer bij het maken van een bundel, controleert u of het geldige JSON is dat naar Blueink wordt verzonden.

Veelgestelde vragen

1. Wat is Blueink?

  • Blueink is een geavanceerde eSignature-oplossing die het proces voor documentondertekening vereenvoudigt, waardoor het eenvoudig is om elektronische documenten veilig te verzenden, ondertekenen en beheren.

2. Wat is de Microsoft Connector voor Blueink?

  • De Microsoft Connector voor Blueink is een hulpprogramma waarmee gebruikers de eSignature-oplossing van Blueink naadloos kunnen integreren met Microsoft Power Automate, waardoor automatisering en verbeterd documentbeheer mogelijk zijn.

3. Hoe werkt de Microsoft Connector voor Blueink?

  • Met de connector kunt u geautomatiseerde werkstromen maken door Blueink te combineren met andere Power Automate-connectors. U kunt het maken en distribueren van documentbundels automatiseren, waardoor uw documentbeheerprocessen worden verbeterd.

4. Wat zijn enkele use cases voor de Microsoft Connector voor Blueink?

  • Veelvoorkomende gebruiksvoorbeelden zijn het automatiseren van goedkeuringen van contracten, het beheren van juridische documenten, het stroomlijnen van papierwerkprocessen en het garanderen van een soepele en efficiënte ervaring voor het ondertekenen van documenten voor klanten en belanghebbenden.

5. Kan ik de Microsoft Connector voor Blueink gebruiken met andere Microsoft-producten?

  • Ja, de connector is ontworpen om naadloos te werken met verschillende Microsoft-producten en -services, zodat u Blueink eSignatures kunt integreren in uw Microsoft-gerichte werkstromen.

6. Is de Microsoft Connector voor Blueink eenvoudig in te stellen en te gebruiken?

  • Ja, het is gebruiksvriendelijk en ontworpen om eenvoudig te zijn. U kunt uw werkstromen configureren en aanpassen aan uw specifieke behoeften voor documentbeheer.

7. Zijn er kosten verbonden aan het gebruik van de Microsoft Connector voor Blueink?

  • De prijzen kunnen variëren op basis van uw gebruiks- en licentieovereenkomsten. U kunt het beste contact opnemen met Blueink of Microsoft voor specifieke prijsinformatie.

8. Kan ik ondersteuning krijgen voor technische problemen met de Microsoft Connector voor Blueink?

  • Ja, Blueink en Microsoft bieden doorgaans ondersteuningsbronnen en documentatie om te helpen bij technische problemen of vragen die u mogelijk hebt met betrekking tot het gebruik van de connector.

9. Is de Microsoft Connector voor Blueink compatibel met zowel Windows- als cloudservices van Microsoft?

  • Ja, de connector is ontworpen om te werken met zowel on-premises als cloudservices van Microsoft en biedt flexibiliteit in uw integratieopties.

10. Waar vind ik meer informatie over de Microsoft Connector voor Blueink?

  • Voor meer informatie, waaronder installatiehandleidingen en documentatie, kunt u de Website van Blueink bezoeken of de Microsoft Power Automate-documentatie met betrekking tot deze connector verkennen.

Een verbinding maken

De connector ondersteunt de volgende verificatietypen:
standaard Parameters voor het maken van verbinding. Alle regio's Niet deelbaar

Verstek

Van toepassing: Alle regio's

Parameters voor het maken van verbinding.

Dit is geen deelbare verbinding. Als de power-app wordt gedeeld met een andere gebruiker, wordt een andere gebruiker gevraagd om expliciet een nieuwe verbinding te maken.

Naam Typologie Description Verplicht
Blueink-API-sleutel beveiligde string Uw Blueink API-sleutel. Dit kan worden gemaakt in Blueink op het tabblad API. De juiste indeling is 'Token XXXXXX' waarbij XXXXXX uw API-sleutel is Klopt

Beperkingslimieten

Name Aanroepen Verlengingsperiode
API-aanroepen per verbinding 100 60 seconden

Acties

Bundelbestanden ophalen

Downloadbare bestanden voor een voltooide bundel ophalen
Bundelgebeurtenissen vermelden

Een lijst met gebeurtenissen ophalen die zijn gekoppeld aan de bundel
Bundelgegevens ophalen

Gegevens ophalen die zijn ingevoerd in velden voor een voltooide bundel
Documentsjablonen weergeven

Alle documentsjablonen weergeven
Een bundel annuleren

Annuleer de bundel die is opgegeven door de Bundel slug
Een bundel maken

Een bundel voor handtekening maken en verzenden
Een bundel ophalen

Een bundel ophalen per slak
Een documentsjabloon ophalen

Een documentsjabloon ophalen
Een herinnering verzenden

Stuur een herinnerings-e-mail of sms naar een ondertekenaar. Een herinnering kan slechts één keer per uur worden verzonden. De herinnering wordt verzonden via de bezorgingsmethode (e-mail of sms) en naar het e-mailadres (of telefoonnummer) dat eerder voor dit pakket is aangewezen.
Een ingesloten ondertekenings-URL maken

Een URL maken die kan worden gebruikt voor ingesloten ondertekening
Een pakket bijwerken

Een pakket (ook wel ondertekenaar genoemd) bijwerken met een nieuw e-mailadres, telefoonnummer, naam of verificatieopties

Het bijgewerkte pakket moet nog steeds productbaar zijn. Als u bijvoorbeeld een deliver_via waarde voor 'telefoon' opgeeft, maar er geen telefoonnummer is ingesteld in de oorspronkelijke PacketRequest, moet deze aanvraag ook een phone waarde bevatten, anders wordt er een fout geretourneerd.

U kunt een pakket wijzigen dat oorspronkelijk is geconfigureerd voor ingesloten ondertekening (dat wil gezegd deliver_via 'insluiten' was) die via e-mail of sms moet worden bezorgd. Er worden echter geen ondertekeningsmeldingen of herinneringen automatisch verzonden. U moet /packet/{packetId}/remind/ aanroepen om een e-mail voor ondertekeningsmeldingen (of sms) te verzenden.

Als deze ondertekenaar is gekoppeld aan een persoon, wordt de persoon ook bijgewerkt: de naam van de persoon wordt gewijzigd (indien opgegeven) en er wordt een nieuw e-mailadres of telefoonnummer toegevoegd.
Een persoon bijwerken

Werk de persoon bij met nieuwe gegevens. Houd er rekening mee dat alle contactkanalen die uit deze aanvraag worden weggelaten, worden verwijderd. Als u niet alle gegevens op de persoon wilt vervangen, wilt u in plaats daarvan PATCH gebruiken.
Een persoon gedeeltelijk bijwerken

Werk de persoon gedeeltelijk bij met nieuwe gegevens.

Als u een nieuw e-mailadres of nieuwe telefoon aan de persoon wilt toevoegen, neemt u een contactkanaal op in de matrix Kanalen zonder een id.

Als u een bestaand contactkanaal wilt bijwerken dat aan de persoon is gekoppeld, neemt u een 'id' op. Dat bestaande contactkanaal wordt bijgewerkt met de nieuwe e-mail of telefoon. Hiermee worden alle livebundels bijgewerkt die zijn gekoppeld aan de persoon die naar die e-mail (of telefoon) wordt verzonden.

Als een ContactChannel geen 'id' bevat, maar het e-mailadres (of de telefoon) overeenkomt met een bestaand contactkanaal, wordt die Contactpersoonkanaal niet gewijzigd.
Een persoon maken

Maak een nieuwe persoon. Een persoon kan worden gekoppeld aan een BlueInk-gebruiker of kan een zelfstandige persoon zijn. Als u een persoon wilt maken die is gekoppeld aan een BlueInk-gebruiker, moet u het user_id veld opgeven. Als u een zelfstandige persoon wilt maken, moet u het name veld opgeven.
Een persoon ophalen

Een persoon ophalen op id
Een persoon verwijderen

Een persoon verwijderen. Hiermee verwijdert u ook alle bijbehorende BlueInk-gebruiker.
Een webhook bijwerken

Werk de Webhook bij met nieuwe gegevens. Houd er rekening mee dat alle abonnementen die uit deze aanvraag worden weggelaten, worden verwijderd. Als u niet alle gegevens in de webhook wilt vervangen, wilt u patch gebruiken.
Een webhook gedeeltelijk bijwerken

Werk de Webhook gedeeltelijk bij met nieuwe gegevens.
Een webhook maken

Een nieuwe webhook maken
Een webhook ophalen

Een webhook ophalen op basis van id
Een webhook verwijderen

Een webhook op id verwijderen
Een WebhookExtraHeader bijwerken

WebhookExtraHeader bijwerken met nieuwe gegevens
Een WebhookExtraHeader gedeeltelijk bijwerken

Werk de WebhookExtraHeader gedeeltelijk bij met nieuwe gegevens.
Een WebhookExtraHeader maken

Een nieuwe webhookheader maken
Een WebhookExtraHeader ophalen

De details van een WebhookExtraHeader ophalen
Een WebhookExtraHeader verwijderen

Een WebhookExtraHeader verwijderen
Gedeeld geheim van webhook opnieuw genereren

Het gedeelde geheim van de webhook opnieuw genereren
Gedeeld geheim voor webhook ophalen

Het gedeelde webhookgeheim ophalen
Lijst Personen

Haal een lijst op met de personen in uw account. U kunt de lijst desgewenst filteren door een zoekquery op te geven. Als u bijvoorbeeld wilt zoeken naar alle personen met de naam 'John', gebruikt u de query search=John.
Lijstbundels

Retourneert een gepagineerde lijst met bundels in uw account, gesorteerd op gemaakte datum (van meest recent naar minst recent). Paginering kan worden beheerd via pagineringsparamaters (zie Overzicht-Paginering>). Parameters voor querytekenreeksfilters kunnen worden gecombineerd, bijvoorbeeld /bundles/?search=Gibbons&status__in=se,co&tag=needs-attention. Bij het combineren van filters worden alleen bundels geretourneerd die overeenkomen met ALLE filters.
List WebhookExtraHeaders

Alle WebhookExtraHeaders weergeven in uw BlueInk-account
Pakketcertificaat van bewijs ophalen

Een koppeling en controlesom ophalen van het bewijscertificaat voor dit pakket
Tags toevoegen aan een bundel

Voeg extra tags toe aan een bundel. Er worden geen bestaande tags in de bundel verwijderd. Het resultaat van deze aanroep is dat Bundle.tags de samenvoeging is van de set vorige tags met de set nieuwe tags. Dubbele tags worden genegeerd.
Tags uit een bundel verwijderen

Verwijder tags uit een bundel. Als een tag in de aanvraag niet bestaat in de bundel, wordt deze genegeerd.
WebhookEvents weergeven

Alle Webhook-gebeurtenissen in uw BlueInk-account weergeven
WebhookEvents weergeven

Alle WebhookDeliveries in uw BlueInk-account weergeven
Webhooks vermelden

Alle webhooks in uw BlueInk-account weergeven

Bundelbestanden ophalen

Bewerkings-id:
getBundleFiles

Downloadbare bestanden voor een voltooide bundel ophalen

Parameters

Name Sleutel Vereist Type Description
Bundel slug
 bundleSlug True string

De slug die de bundel uniek identificeert

Retouren

Name Pad Type Description
array of object
Verloopt
 expires string

Het tijdstip waarop de koppeling verloopt, als iso 8601-notatietijd
file_url
 file_url string

de URL van waaruit het bestand kan worden gedownload

Bundelgebeurtenissen vermelden

Bewerkings-id:
listBundleEvents

Een lijst met gebeurtenissen ophalen die zijn gekoppeld aan de bundel

Parameters

Name Sleutel Vereist Type Description
Bundel slug
 bundleSlug True string

De slug die de bundel uniek identificeert

Retouren

Name Pad Type Description
array of object
beschrijving
 description string

Een korte beschrijving van de gebeurtenis
vriendelijk
 kind string

Het type gebeurtenis als een code van 2 tekens
packet_id
 packet_id uuid

De UUID van een pakket. Alleen aanwezig als de gebeurtenis is gekoppeld aan een bepaald pakket.
tijdstempel
 timestamp date-time

Het tijdstip waarop de gebeurtenis heeft plaatsgevonden

Bundelgegevens ophalen

Bewerkings-id:
getBundleData

Gegevens ophalen die zijn ingevoerd in velden voor een voltooide bundel

Parameters

Name Sleutel Vereist Type Description
Bundel slug
 bundleSlug True string

De slug die de bundel uniek identificeert

Retouren

Name Pad Type Description
array of object
attachments
 attachments array of object

Een matrix met bestandsbijlagen voor een bijlageveld of null
Ext
 attachments.ext string

De bestandsextensie
is_image
 attachments.is_image boolean

waar als dit bijlagebestand een afbeelding is
naam
 attachments.name string

Bestandsnaam van de bijlage
Num
 attachments.num integer

De volgorde waarin het bestand is toegevoegd, als er meerdere uploads zijn voor één bijlageveld (bijvoorbeeld een foto voor elke pagina van een document dat met een webcam is gemaakt)
size
 attachments.size integer

Grootte van het bestand, in bytes
url
 attachments.url url

Een URL die tijdelijk kan worden gebruikt om het bijlagebestand te downloaden
doc_key
 doc_key string

De sleutel die dit document uniek identificeert in de bundel (van de oorspronkelijke BundleRequest)
field_key
 field_key string

De sleutel die het veld in het document uniek identificeert (zoals opgegeven in het oorspronkelijke DocumentRequestField in de DocumentRequest in BundleRequest, of zoals geconfigureerd op de DocumentTemplate)
filled_by
 filled_by string

De pakketsleutel van de ondertekenaar die de waarde voor dit veld heeft ingevoerd. Als de veldwaarde een 'initial_value' is die niet door een ondertekenaar is bewerkt, is de waarde 'initial'. Als de veldwaarde de standaardwaarde is die is geconfigureerd op een DocumentTemplate, is de filler 'standaard'.
vriendelijk
 kind string

Het soort veld
label
 label string

Het label van het veld (mogelijk leeg)
packet_id
 packet_id

De pakket-id van de ondertekenaar die de waarde voor dit veld heeft ingevoerd of null als de veldwaarde niet is ingevuld door een ondertekenaar (dit is een initial_value of defaulwaarde).
waarde
 value

De waarde van het veld.

Documentsjablonen weergeven

Bewerkings-id:
listTemplates

Alle documentsjablonen weergeven

Retouren

Name Pad Type Description
velden
 fields array of

Een matrix met velden die in het document zijn geplaatst. DocumentTemplate-velden zijn iets anders dan DocumentRequest-velden, met een default_value en editor_roles in plaats van initial_value en editors.
file_url
 file_url string

De URL van het oorspronkelijke bestand dat als basis voor deze sjabloon fungeert
is_shared
 is_shared boolean

Waar als de documentsjabloon wordt gedeeld. Anders niet waar
naam
 name string

De naam van het document. De standaardinstelling is de bestandsnaam of het document wanneer het is geüpload, maar kan worden ingesteld op een beschrijvende naam.
roles
 roles array of object
key
 roles.key string

Een tekenreeks die uniek is voor dit document waarmee deze rol wordt geïdentificeerd
label
 roles.label string

Een mensvriendelijk label voor deze rol

Een bundel annuleren

Bewerkings-id:
cancelBundle

Annuleer de bundel die is opgegeven door de Bundel slug

Parameters

Name Sleutel Vereist Type Description
Bundel slug
 bundleSlug True string

De slug die de bundel uniek identificeert

Een bundel maken

Bewerkings-id:
createBundle

Een bundel voor handtekening maken en verzenden

Parameters

Name Sleutel Vereist Type Description
body
 body

De JSON-hoofdtekst waarmee de bundel wordt gedefinieerd die moet worden gemaakt

Een bundel ophalen

Bewerkings-id:
retrieveBundle

Een bundel ophalen per slak

Parameters

Name Sleutel Vereist Type Description
Bundel slug
 bundleSlug True string

De slug die de bundel uniek identificeert

Een documentsjabloon ophalen

Bewerkings-id:
retrieveTemplate

Een documentsjabloon ophalen

Parameters

Name Sleutel Vereist Type Description
Sjabloon-ID
 templateId True uuid

De id waarmee de sjabloon uniek wordt geïdentificeerd

Retouren

Name Pad Type Description
velden
 fields array of

Een matrix met velden die in het document zijn geplaatst. DocumentTemplate-velden zijn iets anders dan DocumentRequest-velden, met een default_value en editor_roles in plaats van initial_value en editors.
file_url
 file_url string

De URL van het oorspronkelijke bestand dat als basis voor deze sjabloon fungeert
is_shared
 is_shared boolean

Waar als de documentsjabloon wordt gedeeld. Anders niet waar
naam
 name string

De naam van het document. De standaardinstelling is de bestandsnaam of het document wanneer het is geüpload, maar kan worden ingesteld op een beschrijvende naam.
roles
 roles array of object
key
 roles.key string

Een tekenreeks die uniek is voor dit document waarmee deze rol wordt geïdentificeerd
label
 roles.label string

Een mensvriendelijk label voor deze rol

Een herinnering verzenden

Bewerkings-id:
sendPacketReminder

Stuur een herinnerings-e-mail of sms naar een ondertekenaar. Een herinnering kan slechts één keer per uur worden verzonden. De herinnering wordt verzonden via de bezorgingsmethode (e-mail of sms) en naar het e-mailadres (of telefoonnummer) dat eerder voor dit pakket is aangewezen.

Parameters

Name Sleutel Vereist Type Description
Pakket slug
 packetId True string

De slug die het pakket uniek identificeert

Een ingesloten ondertekenings-URL maken

Bewerkings-id:
createPacketEmbedURL

Een URL maken die kan worden gebruikt voor ingesloten ondertekening

Parameters

Name Sleutel Vereist Type Description
Pakket slug
 packetId True string

De slug die het pakket uniek identificeert

Retouren

Name Pad Type Description
Verloopt
 expires date-time

Tijdstempel die aangeeft wanneer de URL verloopt
url
 url string

De URL waarin kan worden gebruikt voor ingesloten ondertekening

Een pakket bijwerken

Bewerkings-id:
updatePacket

Een pakket (ook wel ondertekenaar genoemd) bijwerken met een nieuw e-mailadres, telefoonnummer, naam of verificatieopties

Het bijgewerkte pakket moet nog steeds productbaar zijn. Als u bijvoorbeeld een deliver_via waarde voor 'telefoon' opgeeft, maar er geen telefoonnummer is ingesteld in de oorspronkelijke PacketRequest, moet deze aanvraag ook een phone waarde bevatten, anders wordt er een fout geretourneerd.

U kunt een pakket wijzigen dat oorspronkelijk is geconfigureerd voor ingesloten ondertekening (dat wil gezegd deliver_via 'insluiten' was) die via e-mail of sms moet worden bezorgd. Er worden echter geen ondertekeningsmeldingen of herinneringen automatisch verzonden. U moet /packet/{packetId}/remind/ aanroepen om een e-mail voor ondertekeningsmeldingen (of sms) te verzenden.

Als deze ondertekenaar is gekoppeld aan een persoon, wordt de persoon ook bijgewerkt: de naam van de persoon wordt gewijzigd (indien opgegeven) en er wordt een nieuw e-mailadres of telefoonnummer toegevoegd.

Parameters

Name Sleutel Vereist Type Description
Pakket slug
 packetId True string

De slug die het pakket uniek identificeert
body
 body

Een persoon bijwerken

Bewerkings-id:
updatePerson

Werk de persoon bij met nieuwe gegevens. Houd er rekening mee dat alle contactkanalen die uit deze aanvraag worden weggelaten, worden verwijderd. Als u niet alle gegevens op de persoon wilt vervangen, wilt u in plaats daarvan PATCH gebruiken.

Parameters

Name Sleutel Vereist Type Description
Persoons-id
 personId True uuid

De id waarmee de persoon uniek wordt geïdentificeerd
e-mailadres
 email email
identiteitskaart
 id uuid
vriendelijk
 kind string

em voor e-mail. mp voor telefoon.
phone
 phone phone
identiteitskaart
 id uuid
is_user
 is_user boolean

Waar als deze persoon is gekoppeld aan een BlueInk-gebruiker
metadata
 metadata object

Metagegevens die aan deze persoon moeten worden gekoppeld. Metagegevens kunnen worden gebruikt in SmartFill om documenten automatisch te vullen. Zie de SmartFill-documentatie voor meer informatie.
naam
 name string

De naam van de persoon

Retouren

Name Pad Type Description
Kanalen
 channels array of object
e-mailadres
 channels.email email
identiteitskaart
 channels.id uuid
vriendelijk
 channels.kind string

em voor e-mail. mp voor telefoon.
phone
 channels.phone phone
identiteitskaart
 id uuid
is_user
 is_user boolean

Waar als deze persoon is gekoppeld aan een BlueInk-gebruiker
metadata
 metadata object

Metagegevens die aan deze persoon moeten worden gekoppeld. Metagegevens kunnen worden gebruikt in SmartFill om documenten automatisch te vullen. Zie de SmartFill-documentatie voor meer informatie.
naam
 name string

De naam van de persoon

Een persoon gedeeltelijk bijwerken

Bewerkings-id:
updatePersonPartial

Werk de persoon gedeeltelijk bij met nieuwe gegevens.

Als u een nieuw e-mailadres of nieuwe telefoon aan de persoon wilt toevoegen, neemt u een contactkanaal op in de matrix Kanalen zonder een id.

Als u een bestaand contactkanaal wilt bijwerken dat aan de persoon is gekoppeld, neemt u een 'id' op. Dat bestaande contactkanaal wordt bijgewerkt met de nieuwe e-mail of telefoon. Hiermee worden alle livebundels bijgewerkt die zijn gekoppeld aan de persoon die naar die e-mail (of telefoon) wordt verzonden.

Als een ContactChannel geen 'id' bevat, maar het e-mailadres (of de telefoon) overeenkomt met een bestaand contactkanaal, wordt die Contactpersoonkanaal niet gewijzigd.

Parameters

Name Sleutel Vereist Type Description
Persoons-id
 personId True uuid

De id waarmee de persoon uniek wordt geïdentificeerd
e-mailadres
 email email
identiteitskaart
 id uuid
vriendelijk
 kind string

em voor e-mail. mp voor telefoon.
phone
 phone phone
identiteitskaart
 id uuid
is_user
 is_user boolean

Waar als deze persoon is gekoppeld aan een BlueInk-gebruiker
metadata
 metadata object

Metagegevens die aan deze persoon moeten worden gekoppeld. Metagegevens kunnen worden gebruikt in SmartFill om documenten automatisch te vullen. Zie de SmartFill-documentatie voor meer informatie.
naam
 name string

De naam van de persoon

Retouren

Name Pad Type Description
Kanalen
 channels array of object
e-mailadres
 channels.email email
identiteitskaart
 channels.id uuid
vriendelijk
 channels.kind string

em voor e-mail. mp voor telefoon.
phone
 channels.phone phone
identiteitskaart
 id uuid
is_user
 is_user boolean

Waar als deze persoon is gekoppeld aan een BlueInk-gebruiker
metadata
 metadata object

Metagegevens die aan deze persoon moeten worden gekoppeld. Metagegevens kunnen worden gebruikt in SmartFill om documenten automatisch te vullen. Zie de SmartFill-documentatie voor meer informatie.
naam
 name string

De naam van de persoon

Een persoon maken

Bewerkings-id:
createPerson

Maak een nieuwe persoon. Een persoon kan worden gekoppeld aan een BlueInk-gebruiker of kan een zelfstandige persoon zijn. Als u een persoon wilt maken die is gekoppeld aan een BlueInk-gebruiker, moet u het user_id veld opgeven. Als u een zelfstandige persoon wilt maken, moet u het name veld opgeven.

Parameters

Name Sleutel Vereist Type Description
e-mailadres
 email email
identiteitskaart
 id uuid
vriendelijk
 kind string

em voor e-mail. mp voor telefoon.
phone
 phone phone
identiteitskaart
 id uuid
is_user
 is_user boolean

Waar als deze persoon is gekoppeld aan een BlueInk-gebruiker
metadata
 metadata object

Metagegevens die aan deze persoon moeten worden gekoppeld. Metagegevens kunnen worden gebruikt in SmartFill om documenten automatisch te vullen. Zie de SmartFill-documentatie voor meer informatie.
naam
 name string

De naam van de persoon

Retouren

Name Pad Type Description
Kanalen
 channels array of object
e-mailadres
 channels.email email
identiteitskaart
 channels.id uuid
vriendelijk
 channels.kind string

em voor e-mail. mp voor telefoon.
phone
 channels.phone phone
identiteitskaart
 id uuid
is_user
 is_user boolean

Waar als deze persoon is gekoppeld aan een BlueInk-gebruiker
metadata
 metadata object

Metagegevens die aan deze persoon moeten worden gekoppeld. Metagegevens kunnen worden gebruikt in SmartFill om documenten automatisch te vullen. Zie de SmartFill-documentatie voor meer informatie.
naam
 name string

De naam van de persoon

Een persoon ophalen

Bewerkings-id:
getPerson

Een persoon ophalen op id

Parameters

Name Sleutel Vereist Type Description
Persoons-id
 personId True uuid

De id waarmee de persoon uniek wordt geïdentificeerd

Retouren

Name Pad Type Description
Kanalen
 channels array of object
e-mailadres
 channels.email email
identiteitskaart
 channels.id uuid
vriendelijk
 channels.kind string

em voor e-mail. mp voor telefoon.
phone
 channels.phone phone
identiteitskaart
 id uuid
is_user
 is_user boolean

Waar als deze persoon is gekoppeld aan een BlueInk-gebruiker
metadata
 metadata object

Metagegevens die aan deze persoon moeten worden gekoppeld. Metagegevens kunnen worden gebruikt in SmartFill om documenten automatisch te vullen. Zie de SmartFill-documentatie voor meer informatie.
naam
 name string

De naam van de persoon

Een persoon verwijderen

Bewerkings-id:
deletePerson

Een persoon verwijderen. Hiermee verwijdert u ook alle bijbehorende BlueInk-gebruiker.

Parameters

Name Sleutel Vereist Type Description
Persoons-id
 personId True uuid

De id waarmee de persoon uniek wordt geïdentificeerd

Een webhook bijwerken

Bewerkings-id:
updateWebhook

Werk de Webhook bij met nieuwe gegevens. Houd er rekening mee dat alle abonnementen die uit deze aanvraag worden weggelaten, worden verwijderd. Als u niet alle gegevens in de webhook wilt vervangen, wilt u patch gebruiken.

Parameters

Name Sleutel Vereist Type Description
Webhook-id
 webhookId True uuid

De id waarmee de webhook uniek wordt geïdentificeerd
enabled
 enabled boolean
event_types
 event_types array of string

typen gebeurtenissen die de webhook activeren
identiteitskaart
 id uuid
naam
 name string

moet voldoen aan RFC 7230
order
 order integer
waarde
 value string

moet voldoen aan RFC 7230
Webhook
 webhook uuid
identiteitskaart
 id uuid
json
 json boolean
url
 url url

moet de volledige URL zijn, inclusief http/https

Retouren

Name Pad Type Description
enabled
 enabled boolean
event_types
 event_types array of string

typen gebeurtenissen die de webhook activeren
extra_headers
 extra_headers array of object
identiteitskaart
 extra_headers.id uuid
naam
 extra_headers.name string

moet voldoen aan RFC 7230
order
 extra_headers.order integer
waarde
 extra_headers.value string

moet voldoen aan RFC 7230
Webhook
 extra_headers.webhook uuid
identiteitskaart
 id uuid
json
 json boolean
url
 url url

moet de volledige URL zijn, inclusief http/https

Een webhook gedeeltelijk bijwerken

Bewerkings-id:
updateWebhookartial

Werk de Webhook gedeeltelijk bij met nieuwe gegevens.

Parameters

Name Sleutel Vereist Type Description
Webhook-id
 webhookId True uuid

De id waarmee de webhook uniek wordt geïdentificeerd
enabled
 enabled boolean
event_types
 event_types array of string

typen gebeurtenissen die de webhook activeren
identiteitskaart
 id uuid
naam
 name string

moet voldoen aan RFC 7230
order
 order integer
waarde
 value string

moet voldoen aan RFC 7230
Webhook
 webhook uuid
identiteitskaart
 id uuid
json
 json boolean
url
 url url

moet de volledige URL zijn, inclusief http/https

Retouren

Name Pad Type Description
enabled
 enabled boolean
event_types
 event_types array of string

typen gebeurtenissen die de webhook activeren
extra_headers
 extra_headers array of object
identiteitskaart
 extra_headers.id uuid
naam
 extra_headers.name string

moet voldoen aan RFC 7230
order
 extra_headers.order integer
waarde
 extra_headers.value string

moet voldoen aan RFC 7230
Webhook
 extra_headers.webhook uuid
identiteitskaart
 id uuid
json
 json boolean
url
 url url

moet de volledige URL zijn, inclusief http/https

Een webhook maken

Bewerkings-id:
createWebhook

Een nieuwe webhook maken

Parameters

Name Sleutel Vereist Type Description
enabled
 enabled boolean
event_types
 event_types array of string

typen gebeurtenissen die de webhook activeren
identiteitskaart
 id uuid
naam
 name string

moet voldoen aan RFC 7230
order
 order integer
waarde
 value string

moet voldoen aan RFC 7230
Webhook
 webhook uuid
identiteitskaart
 id uuid
json
 json boolean
url
 url url

moet de volledige URL zijn, inclusief http/https

Retouren

Name Pad Type Description
enabled
 enabled boolean
event_types
 event_types array of string

typen gebeurtenissen die de webhook activeren
extra_headers
 extra_headers array of object
identiteitskaart
 extra_headers.id uuid
naam
 extra_headers.name string

moet voldoen aan RFC 7230
order
 extra_headers.order integer
waarde
 extra_headers.value string

moet voldoen aan RFC 7230
Webhook
 extra_headers.webhook uuid
identiteitskaart
 id uuid
json
 json boolean
url
 url url

moet de volledige URL zijn, inclusief http/https

Een webhook ophalen

Bewerkings-id:
getWebhook

Een webhook ophalen op basis van id

Parameters

Name Sleutel Vereist Type Description
Webhook-id
 webhookId True uuid

De id waarmee de webhook uniek wordt geïdentificeerd

Retouren

Name Pad Type Description
enabled
 enabled boolean
event_types
 event_types array of string

typen gebeurtenissen die de webhook activeren
extra_headers
 extra_headers array of object
identiteitskaart
 extra_headers.id uuid
naam
 extra_headers.name string

moet voldoen aan RFC 7230
order
 extra_headers.order integer
waarde
 extra_headers.value string

moet voldoen aan RFC 7230
Webhook
 extra_headers.webhook uuid
identiteitskaart
 id uuid
json
 json boolean
url
 url url

moet de volledige URL zijn, inclusief http/https

Een webhook verwijderen

Bewerkings-id:
deleteWebhook

Een webhook op id verwijderen

Parameters

Name Sleutel Vereist Type Description
Webhook-id
 webhookId True uuid

De id waarmee de webhook uniek wordt geïdentificeerd

Een WebhookExtraHeader bijwerken

Bewerkings-id:
updateWebhookExtraHeader

WebhookExtraHeader bijwerken met nieuwe gegevens

Parameters

Name Sleutel Vereist Type Description
WebhookExtraHeader-id
 webhookExtraHeaderId True uuid

De id die de WebhookExtraHeader uniek identificeert
identiteitskaart
 id uuid
naam
 name string

moet voldoen aan RFC 7230
order
 order integer
waarde
 value string

moet voldoen aan RFC 7230
Webhook
 webhook uuid

Retouren

Name Pad Type Description
identiteitskaart
 id uuid
naam
 name string

moet voldoen aan RFC 7230
order
 order integer
waarde
 value string

moet voldoen aan RFC 7230
Webhook
 webhook uuid

Een WebhookExtraHeader gedeeltelijk bijwerken

Bewerkings-id:
updateWebhookExtraHeaderPartial

Werk de WebhookExtraHeader gedeeltelijk bij met nieuwe gegevens.

Parameters

Name Sleutel Vereist Type Description
WebhookExtraHeader-id
 webhookExtraHeaderId True uuid

De id die de WebhookExtraHeader uniek identificeert
identiteitskaart
 id uuid
naam
 name string

moet voldoen aan RFC 7230
order
 order integer
waarde
 value string

moet voldoen aan RFC 7230
Webhook
 webhook uuid

Retouren

Name Pad Type Description
identiteitskaart
 id uuid
naam
 name string

moet voldoen aan RFC 7230
order
 order integer
waarde
 value string

moet voldoen aan RFC 7230
Webhook
 webhook uuid

Een WebhookExtraHeader maken

Bewerkings-id:
createWebhookExtraHeader

Een nieuwe webhookheader maken

Parameters

Name Sleutel Vereist Type Description
identiteitskaart
 id uuid
naam
 name string

moet voldoen aan RFC 7230
order
 order integer
waarde
 value string

moet voldoen aan RFC 7230
Webhook
 webhook uuid

Retouren

Name Pad Type Description
identiteitskaart
 id uuid
naam
 name string

moet voldoen aan RFC 7230
order
 order integer
waarde
 value string

moet voldoen aan RFC 7230
Webhook
 webhook uuid

Een WebhookExtraHeader ophalen

Bewerkings-id:
getWebhookExtraHeader

De details van een WebhookExtraHeader ophalen

Parameters

Name Sleutel Vereist Type Description
WebhookExtraHeader-id
 webhookExtraHeaderId True uuid

De id die de WebhookExtraHeader uniek identificeert

Retouren

Name Pad Type Description
identiteitskaart
 id uuid
naam
 name string

moet voldoen aan RFC 7230
order
 order integer
waarde
 value string

moet voldoen aan RFC 7230
Webhook
 webhook uuid

Een WebhookExtraHeader verwijderen

Bewerkings-id:
deleteWebhookExtraHeader

Een WebhookExtraHeader verwijderen

Parameters

Name Sleutel Vereist Type Description
WebhookExtraHeader-id
 webhookExtraHeaderId True uuid

De id die de WebhookExtraHeader uniek identificeert

Gedeeld geheim van webhook opnieuw genereren

Bewerkings-id:
regenerateWebhookSecret

Het gedeelde geheim van de webhook opnieuw genereren

Retouren

Name Pad Type Description
create_date
 create_date date-time
secret
 secret b58

Gedeeld geheim voor webhook ophalen

Bewerkings-id:
getWebhookSecret

Het gedeelde webhookgeheim ophalen

Retouren

Name Pad Type Description
create_date
 create_date date-time
secret
 secret b58

Lijst Personen

Bewerkings-id:
listPersons

Haal een lijst op met de personen in uw account. U kunt de lijst desgewenst filteren door een zoekquery op te geven. Als u bijvoorbeeld wilt zoeken naar alle personen met de naam 'John', gebruikt u de query search=John.

Parameters

Name Sleutel Vereist Type Description
Zoekquery
 search string

Een zoekquery.

Retouren

Name Pad Type Description
array of object
Kanalen
 channels array of object
e-mailadres
 channels.email email
identiteitskaart
 channels.id uuid
vriendelijk
 channels.kind string

em voor e-mail. mp voor telefoon.
phone
 channels.phone phone
identiteitskaart
 id uuid
is_user
 is_user boolean

Waar als deze persoon is gekoppeld aan een BlueInk-gebruiker
metadata
 metadata object

Metagegevens die aan deze persoon moeten worden gekoppeld. Metagegevens kunnen worden gebruikt in SmartFill om documenten automatisch te vullen. Zie de SmartFill-documentatie voor meer informatie.
naam
 name string

De naam van de persoon

Lijstbundels

Bewerkings-id:
listBundles

Retourneert een gepagineerde lijst met bundels in uw account, gesorteerd op gemaakte datum (van meest recent naar minst recent). Paginering kan worden beheerd via pagineringsparamaters (zie Overzicht-Paginering>). Parameters voor querytekenreeksfilters kunnen worden gecombineerd, bijvoorbeeld /bundles/?search=Gibbons&status__in=se,co&tag=needs-attention. Bij het combineren van filters worden alleen bundels geretourneerd die overeenkomen met ALLE filters.

Parameters

Name Sleutel Vereist Type Description
Zoekquery
 search string

Een zoekquery. Alleen bundels die overeenkomen met de zoekopdracht worden geretourneerd. De volgende gegevens in de bundel worden doorzocht:

  • bundel slug
  • bundellabel
  • bundel custom_key
  • ondertekenaarnaam
  • e-mailadres van ondertekenaar
  • ondertekenaartelefoons

Bijvoorbeeld. /bundles/?search=foobar@example.com
Bundelstatus
 status string

Beperk bundels tot die met de opgegeven status.

  • Dr: Concept - de bundel is nog niet verzonden
  • se: Sent - the Bundle is sent, but not started by any Signers
  • st: Gestart - ten minste één ondertekenaar is begonnen met het controleren van het document(en)
  • co: Voltooid - alle ondertekenaars hebben het controleren/ondertekenen voltooid
  • ca: Geannuleerd - de bundel is geannuleerd
  • ex: Verlopen - de bundel is verlopen voordat deze is voltooid
  • fa: Mislukt - er is een fout opgetreden en de bundel kan niet worden gemaakt of voltooid

Bijvoorbeeld. /bundles/?status=co
Lijst met bundelstatus
 status__in string

Beperk bundels tot die met een van de opgegeven statussen. Statussen moeten door komma's worden gescheiden. Bijvoorbeeld. /bundles/?status=co,se,st
Bundeltag
 tag string

Retourneert bundels met de opgegeven tag. Bijvoorbeeld. /bundles/?tag=some-tag
Lijst met bundeltags
 tag__in string

Retourneert bundels met ten minste één van de opgegeven tags. Tags moeten door komma's worden gescheiden. Bijvoorbeeld. /bundles/?tag=some-tag,another-tag
Sorteervolgorde bundel
 ordering string

De sorteervolgorde van bundels beheren. Voorvoegsel met '-' om de sorteervolgorde om te draaien. Standaard worden bundels gesorteerd op '-created', dus de datum waarop de bundel wordt gemaakt, van meest naar minst recent.

Retouren

Name Pad Type Description
array of

List WebhookExtraHeaders

Bewerkings-id:
listWebhookExtraHeaders

Alle WebhookExtraHeaders weergeven in uw BlueInk-account

Parameters

Name Sleutel Vereist Type Description
Webhook-id
 webhook uuid

Alleen WebhookExtraHeaders die overeenkomen met de geselecteerde webhook-id worden geretourneerd.

Bijvoorbeeld. /webhooks/headers/?webhook=a053644f-e371-4883-ac17-534445993346
Gebeurtenistype
 event_type string

Alleen WebhookExtraHeaders met webhooks die overeenkomen met de geselecteerde event_type of event_types worden geretourneerd.

Bijvoorbeeld /webhooks/headers/?event_type=bundle_sent/webhooks/headers/?event_type__in=bundle_error,bundle_cancelled

Retouren

Name Pad Type Description
array of object
identiteitskaart
 id uuid
naam
 name string

moet voldoen aan RFC 7230
order
 order integer
waarde
 value string

moet voldoen aan RFC 7230
Webhook
 webhook uuid

Pakketcertificaat van bewijs ophalen

Bewerkings-id:
getPacketCOE

Een koppeling en controlesom ophalen van het bewijscertificaat voor dit pakket

Parameters

Name Sleutel Vereist Type Description
Pakket slug
 packetId True string

De slug die het pakket uniek identificeert

Tags toevoegen aan een bundel

Bewerkings-id:
addBundleTags

Voeg extra tags toe aan een bundel. Er worden geen bestaande tags in de bundel verwijderd. Het resultaat van deze aanroep is dat Bundle.tags de samenvoeging is van de set vorige tags met de set nieuwe tags. Dubbele tags worden genegeerd.

Parameters

Name Sleutel Vereist Type Description
Bundel slug
 bundleSlug True string

De slug die de bundel uniek identificeert
tags
 tags array of string

Een matrix met tags

Tags uit een bundel verwijderen

Bewerkings-id:
removeBundleTags

Verwijder tags uit een bundel. Als een tag in de aanvraag niet bestaat in de bundel, wordt deze genegeerd.

Parameters

Name Sleutel Vereist Type Description
Bundel slug
 bundleSlug True string

De slug die de bundel uniek identificeert
tags
 tags array of string

Een matrix met tags

WebhookEvents weergeven

Bewerkings-id:
listWebhookEvents

Alle Webhook-gebeurtenissen in uw BlueInk-account weergeven

Parameters

Name Sleutel Vereist Type Description
Webhook-id
 webhook uuid

Alleen WebhookEvents die overeenkomen met de geselecteerde webhook-id, worden geretourneerd.

Bijvoorbeeld. /webhooks/events/?webhook=a053644f-e371-4883-ac17-534445993346
Gebeurtenistype
 event_type string

Alleen WebhookEvents met webhooks die overeenkomen met de geselecteerde event_type of event_types worden geretourneerd.

Bijvoorbeeld /webhooks/events/?event_type=bundle_sent/webhooks/events/?event_type__in=bundle_error,bundle_cancelled
Toestand
 status integer

Alleen WebhookEvents die overeenkomen met de geselecteerde status, worden geretourneerd.

Bijvoorbeeld /webhooks/events/?status=1/webhooks/events/?status__in=0,1,2
Geslaagd resultaat
 success boolean

Alleen WebhookEvents die overeenkomen met de geselecteerde successtatus, worden geretourneerd.

Bijvoorbeeld. /webhooks/events/?success=true
Datumbereik
 date date-time

Alleen WebhookEvents die plaatsvinden tussen een datumbereik, worden geretourneerd. Opmerking: datums worden uitgedrukt als JJJJ-MM-DD notatie.

Bijvoorbeeld. /webhooks/events/?date_after=2022-10-01&date_before=2022-10-31

Retouren

Name Pad Type Description
array of object
geschapen
 created date-time
Leveringen
 deliveries array of object
message
 deliveries.message string

een bericht met een beschrijving van eventuele problemen
PK
 deliveries.pk uuid
status
 deliveries.status integer

statusbericht van het antwoord of 0 als er geen status is
tijdstempel
 deliveries.timestamp date-time

wanneer de bezorgingspoging is opgetreden (het begin van de poging, niet wanneer deze is mislukt, bijvoorbeeld voor een time-out)
event_type
 event_type string
payload
 payload string

de nettolading die bij levering moet worden verzonden; json
PK
 pk uuid
status
 status integer

de statuscode van het laatste antwoord van het eindpunt van de webhook. 0 geeft aan dat er geen antwoord is ontvangen
succes
 success boolean
Webhook
 webhook uuid

UUID die identificeert tot welke webhook de gebeurtenis behoort

WebhookEvents weergeven

Bewerkings-id:
listWebhookDeliveries

Alle WebhookDeliveries in uw BlueInk-account weergeven

Parameters

Name Sleutel Vereist Type Description
Webhook-id
 webhook uuid

Alleen WebhookDeliveries die overeenkomen met de geselecteerde webhook-id, worden geretourneerd.

Bijvoorbeeld. /webhooks/deliveries/?webhook=a053644f-e371-4883-ac17-534445993346
Gebeurtenis-id van webhook
 webhook_event uuid

Alleen WebhookDeliveries die overeenkomen met de geselecteerde webhook_event-id worden geretourneerd.

Bijvoorbeeld. /webhooks/deliveries/?webhook_event=a053644f-e371-4883-ac17-534445993346
Gebeurtenistype
 event_type string

Alleen WebhookDeliveries met webhooks die overeenkomen met de geselecteerde event_type of event_types worden geretourneerd.

Bijvoorbeeld /webhooks/deliveries/?event_type=bundle_sent/webhooks/deliveries/?event_type__in=bundle_error,bundle_cancelled
Toestand
 status integer

Alleen WebhookDeliveries die overeenkomen met de geselecteerde status, worden geretourneerd.

Bijvoorbeeld /webhooks/deliveries/?status=1/webhooks/deliveries/?status__in=0,1,2
Datumbereik
 date date-time

Alleen WebhookDeliveries tussen een datumbereik worden geretourneerd. Opmerking: datums worden uitgedrukt als JJJJ-MM-DD notatie.

Bijvoorbeeld. /webhooks/deliveries/?date_after=2022-10-01&date_before=2022-10-31

Retouren

Name Pad Type Description
array of object
geschapen
 created date-time
Leveringen
 deliveries array of object
message
 deliveries.message string

een bericht met een beschrijving van eventuele problemen
PK
 deliveries.pk uuid
status
 deliveries.status integer

statusbericht van het antwoord of 0 als er geen status is
tijdstempel
 deliveries.timestamp date-time

wanneer de bezorgingspoging is opgetreden (het begin van de poging, niet wanneer deze is mislukt, bijvoorbeeld voor een time-out)
event_type
 event_type string
payload
 payload string

de nettolading die bij levering moet worden verzonden; json
PK
 pk uuid
status
 status integer

de statuscode van het laatste antwoord van het eindpunt van de webhook. 0 geeft aan dat er geen antwoord is ontvangen
succes
 success boolean
Webhook
 webhook uuid

UUID die identificeert tot welke webhook de gebeurtenis behoort

Webhooks vermelden

Bewerkings-id:
listWebhooks

Alle webhooks in uw BlueInk-account weergeven

Parameters

Name Sleutel Vereist Type Description
Ingeschakeld
 enabled boolean

Alleen webhooks die overeenkomen met de geselecteerde status Ingeschakeld, worden geretourneerd.

Bijvoorbeeld. /webhooks/?enabled=true
Gebeurtenistype
 event_type string

Alleen webhooks die overeenkomen met de geselecteerde event_type of event_types worden geretourneerd.

Bijvoorbeeld /webhooks/?event_type=bundle_sent/webhooks/?event_type__in=bundle_error,bundle_cancelled

Retouren

Name Pad Type Description
array of object
enabled
 enabled boolean
event_types
 event_types array of string

typen gebeurtenissen die de webhook activeren
extra_headers
 extra_headers array of object
identiteitskaart
 extra_headers.id uuid
naam
 extra_headers.name string

moet voldoen aan RFC 7230
order
 extra_headers.order integer
waarde
 extra_headers.value string

moet voldoen aan RFC 7230
Webhook
 extra_headers.webhook uuid
identiteitskaart
 id uuid
json
 json boolean
url
 url url

moet de volledige URL zijn, inclusief http/https