Webhooks

bountyblok.io can notify your custom webhook endpoint via HTTP POST with a payload containing challenge event data for a user. 
This is commonly used to get notified when a challenge has been completed. The endpoint will also be called for user progress for a challenge with all the necessary data on their progress.
Custom Webhook
First setup a webhook endpoint and then assign it to your bountyblok app in the Apps page. All notifications will include the app_id in the HTTP Request Header: BB-Webhook-Secret-App.
Please validate all incoming requests using BB-Webhook-Secret-App
We recommend you secure your webhook endpoints with HTTPS
An example JSON payload sent to https://example.com/webhook/bountyblok
1
{
2
	"logged_tx": "b5607433a23c2d06c6585543f58fa5a11d3384e8f6c4c631d8fbb9cb3d54852f",
3
	"task_completed_tx": "b5607433a23c2d06c6585543f58fa5a11d3384e8f6c4c631d8fbb9cb3d54852f",
4
	"challenge_completed_tx": "b5607433a23c2d06c6585543f58fa5a11d3384e8f6c4c631d8fbb9cb3d54852f",
5
	"account_name": "captainkarma",
6
	"task_progress": {
7
		"task_id": "6893c17e-5766-4622-b641-87691fa6034d",
8
		"task_name": "Post Something Awesome:",
9
		"quantity_required": 1.0000,
10
		"quantity_completed": 2.0000,
11
		"is_valid": false,
12
		"message": null
13
	},
14
	"challenge_progress": {
15
		"challenge_id": "4af565ca-2975-4392-b34f-2b54e3a8c6b2",
16
		"challenge_name": "Best Meme Contest",
17
		"challenge_score": 100,
18
		"challenge_start": null,
19
		"challenge_end": null,
20
		"challenge_description": "Post the best MEME to win 25 KARMA",
21
		"challenge_rewards": [{
22
				"name": "KARMA",
23
				"value": 25.000000
24
			}
25
		],
26
		"tasks_required": 3,
27
		"tasks_completed": 1,
28
	},
29
	"challenge_reward": {
30
		"name": "KARMA",
31
		"value": 25.000000
32
	},
33
	"is_valid": false
34
}
35
​
Copied!
The payload is sent when a user performs a challenge task. It contains the challenge progress, the current task progress, and the rewards for this user.

API Reference - Previous

Connect Social

Next - Notifications

On-Chain

Last modified 2yr ago

Copy link

Contents

Custom Webhook