Webhook initialization
If you want to start using webhooks with your external system and already have some resources in your doo account, you may need to initialize your system with all these existing resources.
After you make the following API request, we will send a webhook request to your external system for each specified resource item that already exists in your doo account. For example, if you chose to initialize all the events from doo, we will send a separate webhook request for each existing event in your doo account.
We send a maximum of 50 initialization webhook requests per minute, so it may take some time if you want to initialize a lot of data.
Request
curl -X POST 'https://rest.doo.net/v1/webhooks/init/<resource_name>' \
-H 'Content-Type: application/json' \
-H 'x-api-key: <api_key>' \
-H 'Authorization: Bearer <access_token>' \
-d '{
"event_id": <event_id>,
"organization_id": <organization_id>,
"last_updated_after": "<last_updated_after>",
"last_updated_before": "<last_updated_before>",
"webhook_type": ["<webhook_type>", "<webhook_type>", ...],
"webhook_configuration_id": "<webhook_configuration_id>",
"max_rate_per_min": <max_rate_per_min>
}'Parameters
Parameter | Required | Description |
|---|---|---|
| Yes | The resource you want to initialize. See https://viovendi.atlassian.net/wiki/spaces/API/pages/2800549949 for available resource names. |
| Yes | See https://viovendi.atlassian.net/wiki/spaces/API/pages/36929656 |
| Yes | See |
| Yes, only for the following resources:
|
|
| Yes, only for the following resources:
|
|
| No | Use it if you want to initialize resources updated after a particular date and time. Format: Timezone: CET |
| No | Use it if you want to initialize resources updated before a particular date and time. Format: Timezone: CET |
| No | Use it if you want to initialize only particular webhook types. If not specified, all webhook types for the specified resource will be initialized. See for available webhook types for the selected resource. |
| No | In case you have multiple webhook configurations, you can specify the one for which you want to make the initialization. If not specified, all the existing webhook configurations will be initialized. See to get the Webhook Configuration ID. |
| No | Specifies the maximum number of requests per minute that we send for the webhook initialization. You can use this parameter to reduce the load to your system if required. Default value: 100 Minimum value: 1 Maximum value: 100 |
Response example
{
"response_status": 200,
"developer_message": "Success",
"user_message": "Success",
"items_processed": <items_processed_count>,
"_links": {
"self": {
"href": "https://rest.doo.net/v1/webhooks/init/<resource_name>"
}
}
}