← Back to documentation

Endpoint Management

Create and maintain endpoints that accept and forward traffic.

26 min read

An endpoint is an inbound relay URL. It examines the requests and sends the accepted traffic to the configured destinations.

Purpose#

Use this guide to:

  • Create and edit endpoints.
  • Set the method, the payload format, the retries, and the security.
  • Set the field validation.
  • Attach relay targets as destinations.
  • Change the endpoint URL and the lifecycle state.

Before you start#

  • A signed-in account.
  • Relay targets that exist already.
  • A relay target must be Available before you can select it as a destination. A platform email target needs the confirmation. A custom SMTP email target needs a successful connection test.

Procedure#

1. Create endpoint#

  1. Open Endpoints and select Create endpoint.
  2. In Endpoint name above the tabs, enter the name. This value is necessary, with a maximum of 100 characters.
  3. In Details, enter these values:
  • The endpoint type: Webhook endpoint or Email ingestion endpoint. It is the first field of the tab.
  • The description. This value is optional, with a maximum of 500 characters.
  • The expected payload format. For GET and HEAD, only None and the query parameter formats are available.
  1. To change a request rule, select Advanced. For a webhook endpoint, the group holds the accepted HTTP method, the allowed IP version, Ignore Content-Type headers, the rate limit, and the maintenance window. For an email endpoint, it holds the rate limit and the maintenance window.
  2. To deliver the events, attach one relay target or more in Destinations. See Configure destinations.
  3. Select Create endpoint.

The editor has the tabs Details, Destinations, Filter, Transform, Security, and Alerts, in this sequence. A new endpoint uses POST, both IP versions, the Content-Type rule, the rate limit of your plan, and no maintenance window. So the Advanced group is closed at first. The group opens automatically when a value in it is not the default value, or when a value in it has an error.

The Details tab of the endpoint editor with the endpoint type, the description, the payload format, and the closed Advanced group

The Create endpoint button and the Save changes button are in a bar at the bottom of the window. The bar stays visible while you scroll the form. When the editor has unsaved changes, the bar shows You have unsaved changes.

After the save, the endpoint details page opens with the notification Endpoint created. It shows the endpoint URL and a Next step card. For a webhook endpoint, it also shows the request snippets.

When you select Save changes for an existing endpoint, the endpoint details page opens with the notification Endpoint saved. If the failure-alert configuration did not load in the editor, the notification also tells you that PayloadRelay did not save that configuration.

If the new or saved endpoint has no enabled destination, the notification also tells you that PayloadRelay does not deliver events.

If the save fails because of a field error, each tab with an error shows a marker. A screen reader reads the text "(has errors)" after the tab name. In the Destinations tab, an error of one destination shows in the box of that destination. An error of a body filter, a transform rule, or an appended field names the number of the row, for example Transform rule 2.

If the editor cannot load a saved endpoint because of a server error or a network error, the page shows Unable to load the endpoint. Select Try again to load the endpoint again. The page shows Endpoint not found only when the endpoint does not exist or you cannot access it.

If you leave the editor with unsaved changes, the Unsaved changes dialog opens. This occurs for a link in the app and for the browser Back button. Select Stay to continue the edit. Select Leave without saving to leave the editor and discard the changes.

2. Configure details behavior#

  • Any accepts every method. GET and HEAD still have no body.
  • For a body-capable method (JSON, XML, Form, text/plain), the payload format must match the incoming Content-Type. A different Content-Type returns HTTP 415 and records UNSUPPORTED_MEDIA_TYPE.
  • The None format and the query parameter formats accept every Content-Type value.
  • Ignore Content-Type headers: if this control is enabled, PayloadRelay does not examine the Content-Type, and it parses the body in the configured format. All the other endpoint tests still apply. Use this control if a caller sends a wrong header or no header, but gives a payload in the configured format.
  • You can always select the Filter tab and the Transform tab. If the endpoint configuration does not permit these rules, the tab panel tells you the cause. Select Go to Details to change the configuration.

3. Configure delivery retries#

Set the delivery retries for each webhook destination in the Destinations tab:

  • The default is 0. There are no retries.
  • You can set a value to the maximum of your plan for each webhook.
  • The plan limits are Sandbox 1 and Solo 3. The Team trial, Team, Scale, and a custom plan permit 5.
  • Sandbox and Solo use the standard schedule. On the Team trial, Team, Scale, and an eligible custom plan, you can select an advanced schedule and custom retry status codes. These controls are in Advanced delivery configuration on the webhook destination.
  • A target with no retry configuration for the user uses an automatic retry schedule when PayloadRelay supports it. The same plan limit applies.

4. Configure security#

The Security tab supports these controls:

  • Inbound authentication: None, Basic, Bearer token, API key header, or HMAC signature. For the provider presets, see HMAC Inbound Verification.
  • Human verification: None, Cloudflare Turnstile, Google reCAPTCHA.
  • Required request headers, with a maximum of 20 exact-value matches. A header name uses the normal HTTP token syntax, and the match ignores the case. A header name cannot be Authorization, Host, Content-Length, or a hop-by-hop or proxy header. PayloadRelay removes the spaces from a value when it saves the value, and the value cannot be empty. An incoming value must match exactly, with the same case and with no space removal. The required headers do not block a browser CORS preflight test.
  • CORS origins. Enter one exact scheme://host[:port] value in each line. A blank value permits every browser origin.
  • IP allowlist. This control limits the traffic to IP addresses or CIDR blocks. The related Allowed IP version control is in the Details tab, and it can limit the traffic to IPv4 or IPv6. The two controls apply to a webhook endpoint only. See IP Allowlists.

Rules:

  • A captcha needs a body-capable method and a JSON, FORM, or XML payload format. It is not available for None, text/plain, or a query parameter format.
  • The captcha supports Cloudflare Turnstile and Google reCAPTCHA. PayloadRelay stores the configured secret encrypted, and the API never returns it.
  • If you change the captcha provider, enter the secret of the new provider. PayloadRelay deletes the secret of the old provider.
  • PayloadRelay accepts a reCAPTCHA token when Google returns success. PayloadRelay does not apply a reCAPTCHA v3 score. For bot protection, use a reCAPTCHA v2 checkbox key or Cloudflare Turnstile.
  • The captcha field name is a JSON or form field key, a dot path such as captcha.token, or an XPath selector for XML. An XML selector must be in the XPath subset for XML. A stored XML selector outside the subset returns HTTP 400 and records UNSUPPORTED_SELECTOR. The default field names are g-recaptcha-response for reCAPTCHA and cf-turnstile-response for Turnstile. A missing token or an invalid token returns a 4xx status and records CAPTCHA_FAILED.
  • To keep the stored values during an edit, leave the secret fields blank.
  • Include captcha field in payload sets if the captcha token goes to the destinations, with Google Sheets. For a JSON payload and a form payload, PayloadRelay removes the token before the transforms and the delivery when this control is off. PayloadRelay sends the XML with no change.

5. Configure field validation#

Configure the field validation and the request body filters in the Filter tab.

The Filter tab with a request body filter and a field validation rule

Field validation is available in these conditions:

  • The payload format is JSON, FORM, XML, Query Parameters, or Query Parameters (Base64 JSON).
  • GET and HEAD support the field validation only with a query parameter format.

Supported validation types:

  • Any (ANY), String (STRING), Integer (INTEGER), Float (FLOAT), Boolean (BOOLEAN), Email (EMAIL), and Regex (REGEX)

Any does no type test. Use it with Required if the field must only exist.

Notes:

  • Each endpoint can have a maximum of 20 rules. A field name and a selector can have a maximum of 200 characters. You cannot use the same value two times.
  • A JSON, form, and query payload supports a dot-path field such as user.email or items.0.id. A numeric path segment gives the index in an array. PayloadRelay does not support the bracket notation such as items[0].id.
  • An XML field name is an XPath selector in the XPath subset for XML. PayloadRelay rejects a selector outside the subset when you save the rule. At relay time, a stored rule with a selector outside the subset returns HTTP 400 and records UNSUPPORTED_SELECTOR.
  • An XML payload can have a maximum of 100 nested element levels.
  • A type test uses the native JSON types when they are available. INTEGER, FLOAT, and BOOLEAN also accept a text value that holds a valid value, such as "1", "1.5", or "true". This applies to a JSON string and to a form, query, or XML value. REGEX and EMAIL apply to text values.
  • For a JSON endpoint with one field validation rule or more, the payload root must be a JSON object. An array, a scalar, or an empty body returns HTTP 400 and records FIELD_VALIDATION_FAILED.
  • A regex entry needs a valid Java-compatible regular expression of 500 characters or fewer. The matching has a time limit at relay time.
  • The text/plain format and the None format do not apply the field validation.
  • Query Parameters always makes a JSON object, and it supports the standard field validation rules. A necessary query parameter field must be in the URL. An explicit empty value (?key=) is present but blank. A Required rule rejects it. An optional INTEGER, FLOAT, BOOLEAN, or EMAIL rule also rejects it. An absent parameter passes an optional rule.
  • Query Parameters (Base64 JSON) supports the field validation when the root of the decoded JSON is an object. If the endpoint has one field validation rule or more, a decoded array or a scalar returns HTTP 400 and records FIELD_VALIDATION_FAILED. If Required parameter is clear and the Base64 parameter is absent or blank, PayloadRelay skips the field validation and accepts the request. With no rules, PayloadRelay sends an array and a scalar JSON value to the relay targets.

6. Configure request body filters#

A request body filter is an accept rule or a reject rule on the endpoint. The filters apply before the captcha, the field validation, the transforms, the quota consumption, and the delivery. All the configured filters must pass.

Supported filter types:

  • Contains (CONTAINS): the raw body or the query string contains the configured value. The comparison is case-sensitive.
  • Matches (MATCHES): the raw body or the query string is the same as the configured value.
  • Does not contain (DOES_NOT_CONTAIN): the raw body or the query string does not contain the configured value.
  • Regex (REGEX): a Java-compatible regular expression with a time limit on the partial matching.

Limits and behavior:

  • Each endpoint can have a maximum of 10 unique body filter rules.
  • A filter value is necessary and has a maximum of 4,096 characters. A regex pattern must also agree with the safe-regex limit.
  • A JSON, XML, and text payload uses the raw UTF-8 request body. A form endpoint uses the raw form body. A query-parameter format uses the raw URL query string.
  • A None payload clears the body filters, and PayloadRelay does not apply them.
  • An HTTP request body filter that fails returns HTTP 400 and records REQUEST_BODY_FILTER_FAILED. An email body-as-payload filter that fails records the same outcome. PayloadRelay discards the email and sends no bounce message.

7. Configure destinations#

  1. In Destinations, attach one relay target or more. If you have no relay target, select Create relay target in the tab. After you save the relay target, the app returns you to the endpoint editor. The editor does not keep the unsaved changes, so save the endpoint first. Each destination attaches an existing relay target in your account or organization to this endpoint. Its type is the target type (EMAIL, WEBHOOK, SLACK, DISCORD, GOOGLE_SHEETS, MICROSOFT_TEAMS, PAGERDUTY, or TELEGRAM). The API rejects a target with a different type and a target from a different organization.

    The Destinations tab with the list of relay targets to attach and the count of enabled destinations

  2. Use Delivery enabled to keep a destination configured and stop the delivery to that target. If you clear a relay target and select it again before you save, the editor keeps the configuration of that destination. A disabled endpoint stops every destination. A disabled destination stops that target only. The other enabled destinations still receive the deliveries.

  3. Configure the values for each destination:

  • Email: the subject, the Reply-To behavior, and the body format. A subject template removes CR, LF, and NUL after the formatting, to prevent a header injection. A blank formatted subject uses No subject. A Reply-To value must be an email address. A manual value and a fallback value cannot contain CR or LF.

  • Available email body formats:

  • RAW_PAYLOAD: the raw payload with formatting. A text payload or an XML payload arrives as its text, without JSON quotes.

  • RAW_PAYLOAD_ROWS: the raw payload with one field in each row, and an indentation of two spaces for each nested level

  • TEXT: plain text, with an optional custom body template

  • HTML: HTML, with an optional custom body template. PayloadRelay escapes each value that the template inserts, also {{email.htmlBody}}. PayloadRelay does not change the markup that you write in the template. It does not remove a javascript: link from that markup.

  • Slack: the Markdown control, on or off. When it is on, PayloadRelay escapes &, <, and > in each inserted value. So a mention such as <!channel> works only in the literal text of a template. Refer to Slack Incoming Webhooks.

  • Discord: the TTS control, on or off, and an optional cut of a long message. The cut is off by default. If the cut is off, Activity records Discord content that is too large as a failed delivery. A generated message and a template message mention nobody. A message template ignores the cut control. Refer to Message Templates.

  • Microsoft Teams: optional message templates. PayloadRelay stores the destination credentials on the relay target.

  • PagerDuty: PayloadRelay stores the integration key and the severity on the relay target. Create one PagerDuty target for each service or integration key.

  • Telegram: optional message templates. PayloadRelay stores the bot token and the chat ID on the relay target.

  • Google Sheets:

    • Save all fields to Sheet (on by default)
    • If Save all fields to Sheet is off, configure the exact fields to keep
  • Webhook URL:

    • Enforce HTTPS: PayloadRelay rejects the delivery if the target URL is not HTTPS. This control is enabled by default. An HTTPS connection always uses the normal TLS certificate validation. If you disable this control, PayloadRelay still rejects an invalid certificate.
    • Outbound HTTP method: the outbound method, POST, PUT, or PATCH. The default is POST. If an API update omits the method, the saved method stays.
    • Authentication: None, Basic, Bearer token, or API key header. A Basic username cannot contain : or control characters.
    • Forward original request body: PayloadRelay forwards the original request body. This control is selected by default. To send a custom body or no body, clear it.
    • Custom body: this field shows when Forward original request body is clear. If the field is blank, PayloadRelay sends no body. It is an optional body template with template variables. The saved template has a maximum of 65,536 characters. The formatted body has a maximum of 1 MiB. A custom body can use the inbound {{headers.Name}} and {{query.name}} values. PayloadRelay inserts each value as raw text, without JSON escaping. A value that contains ", \, or a line break can make a JSON body invalid. In a JSON body, insert only the values that cannot contain these characters. For a channel-specific template, use Message Templates on a Slack, Discord, Microsoft Teams, or Telegram destination.
    • Content-Type: the outbound content type. The default, Auto-detect from payload format, uses the content type of the payload format when PayloadRelay forwards the original request body. With a custom body, the default is application/json. If PayloadRelay sends no body, it ignores this field. To replace the default, select a listed type. For a different type, select Custom.... Then enter a valid MIME type with a maximum of 100 characters.
    • Delivery retries: the number of retries after a failed delivery. See Configure delivery retries.

    The configuration of a Webhook URL destination with Enforce HTTPS, the outbound HTTP method, the authentication, and the delivery retries

    • Advanced delivery configuration: select this control to show the fields that follow. The section opens automatically when a value in it is not the default value, or when a value in it has an error.
    • Forward all incoming headers and Headers to forward: PayloadRelay forwards all the headers or the selected headers from the incoming request. Forward all incoming headers skips each cf-* header from the Cloudflare edge of PayloadRelay. If you select a cf-* header by name, PayloadRelay forwards it.
    • Custom headers: a maximum of 25 key-value pairs. A name has a maximum of 128 characters. A saved value has a maximum of 4,096 characters, and it can use a template variable such as {{fieldname}}, {{originating_ip}}, {{uuid}}, and {{email.subject}}. Mark a header that holds a credential as sensitive. PayloadRelay encrypts these values, and it does not show them after you save. Each header name must be unique. A header name cannot be a restricted HTTP header. It cannot conflict with the webhook authentication. It cannot be the same as an outbound HMAC signature header, timestamp header, or previous-signature header.

      After the template variable resolution, PayloadRelay removes CR and LF from the outbound header values, and it limits a value to 8,192 characters. If PayloadRelay makes a value shorter, the delivery log records a warning for the target.

    • Retry policy and Retry on status codes: the retry schedule and the status codes that start a retry. See Webhook Retry Presets.
    • Sign requests (HMAC): PayloadRelay signs each delivery with a shared secret. See HMAC Outbound Signing.
    • Delivery payload format: Same as inbound, JSON, XML, Form-encoded, or Plain Text. PayloadRelay converts the payload after the transform rules. For XML, PayloadRelay puts a text payload that is not well-formed XML in a <payload> element.
    • Forward response body: after a successful webhook delivery, PayloadRelay sends its response body to a different supported target. PayloadRelay does not send partial response data when the response is too large. Activity shows the response-forward attempt as failed. PayloadRelay asks the destination for an unencoded response with Accept-Encoding: identity. If the response still has a content encoding, PayloadRelay does not forward it. Activity then records Destination response used a content encoding. The primary delivery stays a success. A PayloadRelay-to-PayloadRelay chain stops after three hops. The hop count includes the hops through an email endpoint. Slack and Discord can shorten the content to their platform limits.
    • Enable failover delivery: for a webhook destination, PayloadRelay sends the payload to a fallback destination when the primary delivery fails permanently. This occurs after the last configured retry. A response that PayloadRelay cannot retry, for example 404, starts the failover after the first attempt. The supported failover destinations are email, webhook, Slack, Discord, and Microsoft Teams. PayloadRelay does not support a Google Sheets, PagerDuty, or Telegram target for a failover. Refer to Retries and Delivery Behavior.

    The Advanced delivery configuration section of a webhook destination with the headers, the retry policy, and the HMAC signing option

  1. Save the changes.

Notes:

  • The enabled primary destinations have a limit for each endpoint: Sandbox 2, Solo 3, the Team trial and Team 5, and Scale 10. For a custom plan, the agreement of the organization sets the limit. A disabled destination configuration and a failover row do not count.
  • If a downgrade makes the limit lower, the oldest permitted destinations stay enabled. PayloadRelay disables the extra destinations, and it keeps their configuration.
  • When the endpoint has the maximum number of enabled destinations, you cannot select Delivery enabled on a disabled destination. The editor shows this reason under the control: To enable this destination, disable a different destination or upgrade your plan.
  • On the endpoint details page, the Destinations tab lists the destinations. Select the name of a destination to open its relay target. Back then returns you to the endpoint details page.
  • If you remove a destination, the other destinations on the endpoint stay.
  • An endpoint can have no destination. PayloadRelay accepts and records the relay requests, and it sends no delivery.
  • If you delete an endpoint, PayloadRelay deletes its destinations. You cannot delete a relay target while a destination uses it.
  • Configure the failover on the primary webhook destination, and not on the endpoint. A webhook failover destination has its own Outbound HTTP method, Retry policy, Failover delivery retries, retry status codes, and Sign failover requests (HMAC). A different supported failover target uses its automatic retry behavior in the plan limit. Activity records a failover attempt as FAILOVER_TRIGGERED.
  • The failover fills in {{query.*}} and {{email.*}} from the original request. If you save the endpoint with the same failover target, PayloadRelay keeps the failover configuration.
  • The failover also runs while the endpoint is paused. A disabled endpoint stops the failover.

Restricted headers

When PayloadRelay forwards the incoming headers to a webhook target, with Forward all incoming headers or with Headers to forward, PayloadRelay always removes these restricted headers:

HeaderReason
HostPayloadRelay sets it for the destination
ConnectionHop-by-hop
Content-LengthPayloadRelay sets it from the outgoing body
Transfer-EncodingHop-by-hop
UpgradeHop-by-hop
Proxy-AuthorizationSecurity-sensitive
Proxy-ConnectionHop-by-hop
TEHop-by-hop
TrailerHop-by-hop
ExpectHop-by-hop
Keep-AliveHop-by-hop
HTTP2-SettingsConnection-specific
AuthorizationSecurity-sensitive. Use the webhook authentication of the destination.
CookieSecurity-sensitive. A session token must not go to a target.
Set-CookieSecurity-sensitive. PayloadRelay must not forward this response header.
Content-TypePayloadRelay sets it from the payload format and the content-type replacement
Accept-EncodingPayloadRelay sets it. The delivery service does not decode a compressed response.
CDN-LoopCloudflare uses it to find a loop. A forwarded value can make Cloudflare reject the delivery to a destination behind Cloudflare.
X-PayloadRelay-Forward-ChainSigned loop-protection metadata that PayloadRelay manages
X-PayloadRelay-Delivery-IdDelivery identity metadata that PayloadRelay manages
X-PayloadRelay-Event-IdEvent identity metadata that PayloadRelay manages
X-PayloadRelay-AttemptDelivery-attempt metadata that PayloadRelay manages

PayloadRelay also removes the endpoint-specific credential headers and validation headers: each configured required request header, the configured inbound API-key header, the inbound HMAC signature header, and the Slack timestamp header when the Slack HMAC preset is active. PayloadRelay never gives these dynamic names to a body template, and it never forwards them automatically. If you select one of them, the protection stays. If the destination needs its own credential, add the value separately as outbound authentication or as a sensitive custom header on the destination.

If Forward all incoming headers is enabled, PayloadRelay removes the static headers and the endpoint-specific headers in the list above. If you add a static restricted name to the list of specific forwarded headers, the API rejects the configuration. So it does not save a value that it ignores. If a name that you saved before is restricted now, PayloadRelay removes it at the next save. PayloadRelay can forward all the other incoming headers.

Google Sheets delivery behavior

  • PayloadRelay adds each accepted payload as a new row.
  • PayloadRelay matches the columns to the field names, and it ignores the case.
  • PayloadRelay creates a missing column automatically, and it uses the field name as the header.
  • For an XML, text/plain, and None flow, payload is the only supported configured field.
  • For a query parameter format, also on GET and HEAD, you can select the individual parsed fields.

8. Configure email ingestion#

Email ingestion permits an endpoint to receive an email as a relay payload. It needs no HTTP request.

  1. In the Details tab of the endpoint editor, select Email ingestion endpoint in the Endpoint type list.
  2. Save the endpoint.
  3. Open the saved endpoint and copy the emailIngestionAddress that the API gives.
  4. Use that address as a recipient in the system that sends the email.
  5. PayloadRelay converts the incoming email into a JSON payload with the sender, the recipients, the subject, the text body and the HTML body, the headers, and the metadata.
  6. PayloadRelay removes the attachments. It relays the text content only.
  7. Each new accepted inbound email consumes one accepted event from the monthly quota. A completed second delivery that PayloadRelay identifies consumes no quota.

Notes:

  • An endpoint is a Webhook endpoint or an Email ingestion endpoint. It cannot be both.
  • A change of the endpoint type clears the values for that type. For example, a change to email clears the inbound authentication, the captcha, the IP limits, the CORS, and the required headers. In the editor of a saved endpoint, a warning under Endpoint type tells you what the save clears. If you select the saved type again before you save, the editor restores the HTTP method and the payload format.
  • The endpoint must be enabled to accept an inbound email.
  • Activity shows Email Accepted (EMAIL_INGESTION_ACCEPTED) for an accepted email relay. A rejection uses the most specific outcome that is available, such as Auth Failed (AUTH_FAILED), Body Filter Failed (REQUEST_BODY_FILTER_FAILED), Validation Failed (FIELD_VALIDATION_FAILED), Malformed JSON Payload (MALFORMED_JSON_PAYLOAD), or Email Rejected (EMAIL_INGESTION_REJECTED).

9. Pause and auto-resume#

Pause an endpoint for a period, and do not disable it. During the pause, a webhook request receives 503 Service Unavailable. An inbound email receives a temporary SMTP 451. The two responses create no Request activity row.

To pause an endpoint:

  1. Open the endpoint details page or the endpoint edit page. You can pause a saved endpoint only. The endpoint must be enabled.

  2. In the page header, select Pause.

  3. Select 1 hour, 6 hours, 24 hours, or Custom... for 1 to 43,200 minutes.

    The Pause menu with the durations 1 hour, 6 hours, 24 hours, and Custom

    The Pause endpoint dialog with the duration in minutes

  4. Read the badge, such as Paused. The endpoint resumes in 3h 20m.

    The page header of a paused endpoint with the pause badge and the Resume now button

Pause and the Enabled switch apply a change immediately. They do not wait for Save changes. The other changes in the editor apply only when you save.

To resume early:

  • To clear the pause immediately, select Resume now next to the pause badge.
  • The endpoint accepts traffic again immediately.

Behavior notes:

  • A webhook request during a pause receives HTTP 503. An inbound email receives SMTP 451. The PayloadRelay mail server keeps the email and sends it again for a maximum of 2 days. If the pause is longer, the mail server returns the email to the SMTP envelope sender.
  • The endpoint resumes after the selected period. You do not have to do anything.
  • A pause is different from a disable. An endpoint with enabled=false returns 404. A paused endpoint returns 503.
  • PayloadRelay keeps the selected resume time until the endpoint resumes automatically, or until you resume it manually.

10. URL rotation and lifecycle actions#

  • Regenerate URL creates a new endpoint URL immediately. The editor discards the unsaved changes, so save the endpoint first.
  • The old URL stops to accept requests immediately.
  • To enable or disable the endpoint, use the Enabled switch in the page header of the edit page. The change applies immediately.
  • To delete the endpoint, go to the Delete endpoint section at the end of the edit page. Select Delete endpoint, and then select Delete endpoint in the dialog. PayloadRelay deletes the endpoint and its related Activity history permanently. After the deletion, the app shows Endpoint deleted and opens the endpoint list.

11. Failure-rate alerts#

Configure an alert for each endpoint. The alert fires when the failure rate in a rolling window is equal to a threshold or higher. You can also pause the endpoint automatically when an alert fires. For the details, see the Failure-Rate Alerts guide.

12. Find endpoints in the list#

The Endpoints page lists your endpoints. Select the name of an endpoint to open its details page.

The Endpoints page with the status filter and the requests of each endpoint in the last 7 days

The Last 7 days column shows the number of requests of each endpoint, and the time of the last request. The count covers 7 UTC days, today included. It starts at 00:00 UTC 6 days ago, so it agrees with the Week window of the Activity page. If requests failed, the column also shows the number of failed requests, for example 2 failed. Select that number to open the failed requests of the endpoint in the Request log. An endpoint with no request in the 30-day Activity trail shows No requests in 30 days.

Use the Status filter to show the endpoints in one state:

  • All: every endpoint.
  • Enabled: an enabled endpoint that is not paused and has one destination or more.
  • Paused: an enabled endpoint with a pause that is in effect.
  • No destinations: an enabled endpoint that is not paused and has no destination.
  • Disabled: an endpoint that is disabled (enabled=false).

The badge Active endpoints: n / m shows the number of enabled endpoints (n) and the active endpoint limit of your plan (m). Each enabled endpoint counts as an active endpoint. A paused endpoint is an enabled endpoint, so it counts. A disabled endpoint does not count. When you reach the limit, disable an endpoint before you enable a different endpoint, or upgrade your plan in Billing. The endpoint list then shows a link to Billing.

Expected result#

  • The endpoint appears with the expected method, format, and security configuration.
  • The accepted traffic appears as Pending while the deliveries are in progress, then it moves to a final outcome. The dashboard shows the label Completed for final ACCEPTED traffic.
  • The selected destinations receive the deliveries.
  • A Google Sheets destination adds rows to the selected spreadsheet and sheet.

Common issues and fixes#

  • "No relay targets": create the targets first. See Configure destinations.
  • The email destination is not available: make sure that the email target is available.
  • PayloadRelay rejects the Google Sheets field selection: if Save all fields to Sheet is off, add a field. Use payload only for an XML, text/plain, or None endpoint.
  • Validation errors: examine the field names, the types, and the patterns.
  • Captcha errors: make sure that the token field name and the provider secret are correct.
  • Delivery errors: examine the target URL, the authentication, the headers, and the TLS configuration.
  • Unexpected 3xx failures: PayloadRelay does not obey an HTTP redirect. A webhook target must answer directly with a 2xx status code.

Throughput controls#

For each endpoint, you can set Requests per minute in the Advanced group of the Details tab. An email endpoint shows Emails per minute. To use the default of your plan, leave it blank. You can also enter a positive integer up to the limit of your plan. A request above the effective limit returns 429 Too Many Requests with a Retry-After header, and Activity records RATE_LIMITED_ENDPOINT. An email above the limit receives SMTP 451. For the details, see Endpoint Rate Limits.