Client webhook

To be notified when an invitee accepts an invitation, the client submits a webhook with the invitation creation request. This webhook invocation will include a valid Identity access token associated with the Invitation Service application. An invitation has been accepted when the user logs in via the link sent.

The created invitation (see Create an end-user invitation) and Webhook payloads both contain the webhook_secret_token parameter. Your application should confirm that this value matches the value you provided when creating the invitation and that the API has been safe listed. This ensures that Invitation Service invokes the webhook.

To create a webhook:

POST invitation_accepted_webhook (see Create an end-user invitation)

• HEADER:

  • Include TID OAuth Bearer token for your application

  • Add a Content-Type of application/JSON.

• Body

  • user_id: Trimble Identity user ID

  • invitation_id: Invitation service ID

  • invite_email_address: (type=email) - (Invitee’s Email Address)

  • status: complete

  • webhook_secret_token: Token provided on invitation creation

  • metadata: metadata from creation

Webhook calls must to be safe listed.

Example request body:

{
    "user_id": "18a0550b...",
    "invitation_id": "ad8c2590...",
    "status": "complete",
    "webhook_secret_token": "4316299750...",
    "invite_email_address": "abc@trimble.com",
    "metadata": {}
}

Example response

{
    "redirect_url": "https://www.trimble.com/"
}