POST /previews/webhooks

Sends a test webhook.

Servers

https://api-sandbox.rebilly.com/organizations/{organizationId}
https://api.rebilly.com/organizations/{organizationId}

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`id`	String	No	ID of the webhook.
`_links[]`	Array	No	Related links.
`_links[].href`	String	No	Link URL.
`_links[].rel`	String	No	Type of link. Valid values: `"self"`
`eventsFilter[]`	Array	No	Event types that trigger the webhook. If empty, all event types trigger the webhook.
`method`	String	Yes	Valid values: `"POST"` `"PUT"` `"DELETE"` `"GET"` `"PATCH"`
`updatedTime`	String	No	Date and time when the batch was last updated.
`url`	String	Yes	URL that receives requests when a specified event occurs.
`filter`	String	No	Filter that determines whether to send the webhook. This field requires a special format. Use `,` for multiple allowed values. Use `;` for multiple fields. For more information, see Using filters.
`credentialHash`	String	Yes	Credential hash for authenticating requests to the URL.
`createdTime`	String	No	Date and time when the batch was created.
`body`	String	No	Webhook request body. If this value is `null`, the default payload for the specified event is used. Template placeholders are permitted. Invalid placeholders render as empty strings. For example, `Hello {{invalid.placeholder}}!` is rendered as `Hello !`. For more information, see Placeholders.
`status`	String	No	Valid values: `"inactive"` `"active"` Default value: "active"
`headers[]`	Array	No	Headers to include in the webhook request.
`headers[].name`	String	Yes	Name of the header.
`headers[].status`	String	No	Status of the header. Valid values: `"inactive"` `"active"` Default value: "active"
`headers[].value`	String	Yes	Value of the header.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.