Skip to content

Commit 7e9fa27

Browse files
docs: restore old webhook documentation
1 parent 008fd1a commit 7e9fa27

File tree

4 files changed

+26
-1
lines changed

4 files changed

+26
-1
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -331,6 +331,10 @@ Class | Method | HTTP request | Description
331331
- [Sealed](docs/Sealed.md)
332332
- [DecryptionKey](docs/DecryptionKey.md)
333333

334+
## Documentation for webhooks
335+
336+
- [Webhook](docs/SdkWebhook.md)
337+
334338
## Support and feedback
335339

336340
To report problems, ask questions or provide feedback, please use [Issues](https://github.com/fingerprintjs/fingerprintjs-pro-server-api-node-sdk/issues). If you need private support, you can email us at [[email protected]](mailto:[email protected]).

docs/SdkWebhook.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# FingerprintPro.ServerSdk.Webhook
2+
3+
## **IsValidWebhookSignature**
4+
5+
> bool IsValidWebhookSignature(string header, byte[] data, string secret)
6+
7+
Verifies the HMAC signature extracted from the "fpjs-event-signature" header of the incoming request. This is a part of
8+
the webhook signing process, which is available only for enterprise customers.
9+
If you wish to enable it, please contact our support: https://fingerprint.com/support
10+
11+
### Required Parameters
12+
13+
| Name | Type | Description | Notes |
14+
|------------|--------------|-------------------------------------------------|-------|
15+
| **header** | **string** | The value of the "fpjs-event-signature" header. | |
16+
| **data** | **byte[]** | The raw data of the incoming request. | |
17+
| **secret** | **string[]** | The secret key used to sign the request | |

generate.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# clean models and docs before generating
44
find ./src/FingerprintPro.ServerSdk/Model -type f ! -name "DictionaryModel.cs" -exec rm {} +
5-
find ./docs -type f ! -name "DecryptionKey.md" ! -name "Sealed.md" -exec rm {} +
5+
find ./docs -type f ! -name "DecryptionKey.md" ! -name "Sealed.md" ! -name "SdkWebhook.md" -exec rm {} +
66

77
# jar was downloaded from here https://repo1.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/3.0.34/
88

template/README.mustache

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -251,6 +251,10 @@ Authentication schemes defined for the API:
251251
- [Sealed](docs/Sealed.md)
252252
- [DecryptionKey](docs/DecryptionKey.md)
253253

254+
## Documentation for webhooks
255+
256+
- [Webhook](docs/SdkWebhook.md)
257+
254258
## Support and feedback
255259

256260
To report problems, ask questions or provide feedback, please use [Issues](https://github.com/fingerprintjs/fingerprintjs-pro-server-api-node-sdk/issues). If you need private support, you can email us at [[email protected]](mailto:[email protected]).

0 commit comments

Comments
 (0)