Skip to content

Commit

Permalink
update webhooks guides for dashboard
Browse files Browse the repository at this point in the history
  • Loading branch information
niall-maloney committed Jan 3, 2023
1 parent 843cfa2 commit 51202f6
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 14 deletions.
Binary file added assets/images/webhooks/Create-Subscription2.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/webhooks/Generate-Secret2.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/webhooks/Test-Event2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/webhooks/Webhook-Messages2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 6 additions & 6 deletions docs/webhooks/Getting-Started.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,19 @@ Download ngrok [here](https://ngrok.com/download), then follow their getting sta

## Configuring webhooks through the portal

Once you’re up and running with ngrok you will need to configure your webhooks through our portal, using the left menu to navigate to the webhook pages
Once you’re up and running with ngrok you will need to configure your webhooks through our dashboard, using the left menu to navigate to the webhook pages

1. Navigate to the webhooks secret page. Click on 'Generate secret' and save its value for later. Note that you may only have two active secrets.
1. Navigate to the webhooks configuration section and click on the `+` button. Select your desired secret lifetime and then click on 'Create secret' and save its value for later. Note that you may only have two active secrets.

![Generate a secret in the portal](../../assets/images/webhooks/Generate-Secret.gif)
![Generate a secret in the portal](../../assets/images/webhooks/Generate-Secret2.gif)

2. Navigate to the webhook subscriptions page, click on 'Create' and use the HTTPS URL provided by ngrok, ensuring you specify the path that your application has been set up on e.g. `https://9999-123-456-789-12.ngrok.io/webhooks`.
2. Navigate to the webhook subscriptions section and click on the `+` button. Enter the HTTPS URL provided by ngrok, ensuring you specify the path that your application has been set up on e.g. `https://9999-123-456-789-12.ngrok.io/webhooks`. Select the event type 'Test event (v1)', then click on 'Add subscription'.

![Create a webhook subscription](../../assets/images/webhooks/Create-Subscription.gif)
![Create a webhook subscription](../../assets/images/webhooks/Create-Subscription2.gif)

Ensure ngrok is running and forwarding traffic to the port on which your local application is running.

You can then send the test event by clicking the button in admin portal or sending an API request.
You can then send the test event by clicking the button in the dashboard or sending an API request.

## Receiving the webhook request

Expand Down
16 changes: 8 additions & 8 deletions docs/webhooks/Testing.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Testing

To enable you to check you have set up your infrastructure correctly, we offer a test event type. This can be triggered via API or in our portal in the subcriptions page.
To enable you to check you have set up your infrastructure correctly, we offer a test event type. This can be triggered via API or in our dashboard webhooks configuration page.

![Create a webhook subscription](../../assets/images/webhooks/Create-Subscription1.png)
![Create a webhook subscription](../../assets/images/webhooks/Test-Event2.png)

It does not contain any information pertaining to a resource, just the following:

Expand All @@ -19,22 +19,22 @@ It does not contain any information pertaining to a resource, just the following
}
```

Note that if this is triggered from our portal, the payload will be:
Note that if this is triggered from our dashboard, the payload will be:

```json
“payload”: {
"event": "This event was sent from Admin Portal."
"event": "This event was sent from WealthKernel Dashboard."
}
```


You can view the status of webhook requests in our portal.
You can view the status of webhook requests in our dashboard.

![Create a webhook subscription](../../assets/images/webhooks/Webhook-Messages.png)
![Create a webhook subscription](../../assets/images/webhooks/Webhook-Messages2.png)

The details of an individual request can be seen from the details page, including the HTTP status code we received. You can also manually retry from this page should the automatic retries have been exhausted.
The details of an individual request can be seen from the details page, including the HTTP status code we received. You can also manually resend from this page should the automatic retries have been exhausted.

![Create a webhook subscription](../../assets/images/webhooks/Webhook-Messages-Details.png)
![Create a webhook subscription](../../assets/images/webhooks/Webhook-Messages-Details2.png)

Webhooks are also available to try out on our sandbox environment.

Expand Down

0 comments on commit 51202f6

Please sign in to comment.