PApartoo
Webhooks

Send test webhook payloads

Changed on

This endpoint let you try webhook configurations by sending test payloads. This currently supports only one webhook configuration per request, entries after the first one will be ignored. Payloads are created by the latest data of the specified event type, or if not available a default payload will be sent. The request is similar to a regular webhook, but also contains an additional X-Partoo-Webhook-Tryout header.

post/webhooks/tryout

Request

Query parameters

org_idinteger

Organization identifier, only required for PROVIDER users.

Request body

Example request

{
  "items": [
    {
      "url": "https://example.com/webhook",
      "event_type": "business_created",
      "custom_headers": {
        "X-My-Header": "my-value",
        "X-Auth-Token": "secret-token"
      }
    }
  ]
}

Response

OK

Example response

{
  "items": [
    {
      "event_type": "business_created",
      "url": "https://example.com/webhook",
      "status": "success"
    }
  ]
}

Changes

  • dcb8190f5a29Revision changes
    • warning

      added the new email_opt_out_created enum value to the /// response property for the response status

    • warning

      added the new post_created enum value to the /// response property for the response status

    • warning

      added the new post_deleted enum value to the /// response property for the response status

    • warning

      added the new post_updated enum value to the /// response property for the response status

    • warning

      added the new post_validated enum value to the /// response property for the response status

    • warning

      added the new review_created enum value to the /// response property for the response status

    • warning

      added the new review_reply_created enum value to the /// response property for the response status

    • warning

      added the new review_reply_deleted enum value to the /// response property for the response status

    • warning

      added the new review_reply_updated enum value to the /// response property for the response status

    • warning

      added the new review_updated enum value to the /// response property for the response status

    • warning

      added the new scheduled_post_pushed enum value to the /// response property for the response status