Send a webhook

This helper lets you send data to a custom internal app or an app that we haven't integrated with yet

This helper performs an HTTP request to post data to an API endpoint. It's useful when

• You want to create a new item in your internal app

• You want to create items in an app Ply doesn't integrate with yet

• You want to perform a POST action that we haven't built yet

How to set up a POST request step

A POST request requires a URL endpoint and a "content type" – essentially, a format in which the main "body" of the request will be submitted. Once these are provided, additional fields will appear where the body, authentication, and custom headers can be provided.

URL endpoint

To make a POST request you need to provide the URL endpoint that you want to send the request to. Typically, this URL will be found in the API documentation or reference of the app you're trying to connect with.

Content type

The "Content Type" refers to the format or structure in which the data will be sent in the API request's body. Here's a breakdown of each option:

1. JSON

   • Probably the most common

   • Uses key-value format

     • Must be wrapped in { } and all keys and all text values must be wrapped in " ", for example:
2. Form URL encoded

   • Form URL encoding represents the data as a series of key-value pairs separated by ampersands (&).

   • This format is commonly used when submitting HTML forms or when working with traditional web applications.

3. XML

4. Plain text

5. Raw

Select the appropriate "Content Type" based on the format that API endpoint requires to process your data accurately. Make sure to choose the option that aligns with the specific data structure or format you are using for your API request.

Basic authentication

The basic authentication field is a slightly outdated way for showing that you are authorized to make the request. If the API documentation indicates to use it, you should enter a username and password separated a colon (:).

Custom headers

Custom headers are used to provide additional context about the request, like who the requester is (i.e. authorization), what is being requested, what format the response should be returned in, and more.

For example, if the API says that you must authorize your request with an access token, that will be included in a custom header.

Custom headers must be provided in a JSON dictionary format e.g.