Webhooks

Webhooks underretter og hjælper med at indsamle oplysninger om de vigtigste begivenheder, som sker i Enterprise-projektet, såsom færdiggjort oversættelse/korrekturlæsning. Efter opsætning af en webhook til projektet, vil Enterprise begynde at sende POST- eller GET-anmodninger med data til webhook URL’en via HTTP.

Kun gruppe-/projektadministratorer og -adminis kan registrere en webhook.

Brugsstudier

Der kan tilføjes webhooks til at opbygge integrationer med tjenesterne eller med en backend. F.eks.:

• Opsæt en webhook for at sende notifikationer til det brugte system.
• Videresend oplysninger til tredjepartstjenester med specifikke forespørgselskrav (f.eks. HTTP-metode, indholdstype).
• Opret tilpassede integrationer med Enterprise.

Events

Webhooks kan opsættes til flg. begivenheder:

• File fully translated – a file is translated into one of the target languages
• File fully reviewed – translations in a file are approved for one of the target languages
• File added
• File updated
• File reverted
• File deleted
• Project fully translated – all files are translated into one of the target languages
• Project fully reviewed – translations in all files are approved for one of the target languages
• Project successfully built
• Exported translation updated – final translation of a string is updated
• Source string added
• Source string updated
• Source string deleted
• Suggested translation added – a string in the project is translated
• Suggested translation updated – a translation for a string in the project is updated
• Suggested translation deleted – one of the translations is deleted
• Suggested translation approved – a translation for a string is approved
• Suggested translation disapproved – approval for a previously added translation is removed
• String comment/issue created
• String comment/issue updated
• String comment/issue deleted
• String comment/issue restored
• Task added
• Task status changed
• Task deleted

Webhook Payload-eksempler

Visit Webhooks acticle on Crowdin Developer Portal.

Tilføjelse af Webhooks

To configure webhooks in Crowdin Enterprise, open your project and go to Integrations > Webhooks on the left panel. Click Create to start configuring your new webhook.

Flg. oplysninger skal angives for at registrere en webhook:

• The webhook name (for example, “New translation added”).
• Begivenhederne, som skal overføres URL’en. Der kan enten vælges en begivenhed eller et bestemt begivenhedssæt.
• URL’en, hvortil callback skal sendes.
• Forespørgselsmetoden, der angiver den ønskede handlingsudførelse for en given ressource (brug enten GET eller POST).
• Indholdstypen for POST-anmodningsmetoden (multipart/form-data, application/json, eller application/x-www-form-urlencoded).
• For applikations-/json-indholdstypen kan vælge sBatch webhooks for at fusionere flere begivenheder til én enkelt forespørgsel.

Optionally, you can add special headers to your webhook. De kan bruges til ekstra sikkerhed som en godkendelsesmetode og meget mere. For example, if you add headers, your webhook endpoint can check them to ensure that information is coming from Crowdin Enterprise.

When adding a webhook, you can test how your application will react to that call.

Depending on your approach to webhooks management, you might need to add dedicated Crowdin Enterprise IP addresses to your firewall to allow Crowdin Enterprise to open the pre-configured webhook URLs.

Read more about IP Addresses.

Tilpassede payloads

Each event type in Crowdin Enterprise has a specific payload format with the relevant event information. You can customize the webhook payload to add and organize the elements the way your system requires.

To check the event’s possible variables, hover over the Info icon in the Payload section’s right upper corner.

Sende Webhooks til Slack

With the help of Crowdin Enterprise webhooks, you can send notifications about pre-configured event types directly to a specific Slack channel.

To configure the webhooks’ sending to Slack, you’d need to create a simple Slack app. Read more about Sending messages to Slack using Incoming Webhooks.

As soon as you create and configure your Slack app, you’ll have a Webhook URL that should be used for the Webhooks configuration in your Crowdin Enterprise project.

Redigere eller Slette Webhooks

Man kan tilgå listen over alle eksisterende webhooks i et bestemt projekt. Webhooks kan redigeres eller slette direkte fra den viste liste.

Aktiviteter

After the events are triggered, you will be able to review the activity of each webhook separately. Use the filter to review all or only unsuccessful webhook notifications.

Alternatively, you can review the full list of sent webhooks in the Webhooks Log. Filter webhook notifications by result (Any or Unsuccessful), event types, or name.

Søge assistance

Behov for hjælp til brug af Webhooks eller evt. spørgsmål? Kontakt Supportteamet.