POST v{version}/webhooks/types/subscription

Details

Subscribe to a specific webhook.

https://api.procurewizard.com/v1.0/webhooks/types/subscription

Request

URI Parameters

These are parameters passed as part of the URL in the request.

Name	Description	Type	Additional information
version	The API version parameter. The current version is 1.0.	string	None

Body Parameters

A webhook event type request object. This is a request from a client.

WebhookEventTypeRequest

Name	Description	Type	Additional information
data	The responses data.	WebhookEventTypeRequestData	None
jsonApi	Implementation details of JSON:API.	Implementation	None
meta	A meta object used to include non-standard meta-information. Client meta data will be ignored by the server.	MetaData	None

Request Formats

    
{
  "data": {
    "id": "56789",
    "type": "webhookeventtype",
    "attributes": {
      "name": "Sample string 1"
    }
  }
}

    
<WebhookEventTypeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.Webhooks">
  <JsonApi xmlns:d2p1="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.JsonApi" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api" />
  <Meta i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.JsonApi" />
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.Webhooks" xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api">
    <Id xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.JsonApi">56789</Id>
    <Type xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.JsonApi">webhookeventtype</Type>
    <Attributes xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.JsonApi">
      <d2p1:Name>Sample string 1</d2p1:Name>
    </Attributes>
  </Data>
</WebhookEventTypeRequest>

Response

Response Description

A response object of WebhookEventTypeResponse

Name	Description	Type	Additional information
data	The responses data.	WebhookEventTypeResponseData	None
jsonApi	Implementation details of JSON:API.	Implementation	None
links	Related links.	Links	None
meta	A meta object used to include non-standard meta-information. Client meta data will be ignored by the server.	MetaData	None

Response Formats

Example responses of what the data might contain.

    
{
  "data": {
    "id": "12345",
    "type": "webhookeventtype",
    "attributes": {
      "endPointUrl": "Sample string 1",
      "name": "Sample string 2"
    }
  },
  "links": {
    "self": {
      "href": "http://example-url-1.com"
    },
    "related": {
      "href": "http://example-url-1.com"
    }
  },
  "meta": {
    "copyright": "© 2025 The Access Group"
  },
  "jsonApi": {
    "version": "1.0"
  }
}

    
<WebhookEventTypeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.Webhooks">
  <JsonApi xmlns:d2p1="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.JsonApi" xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api">
    <d2p1:Version>1.0</d2p1:Version>
  </JsonApi>
  <Links xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.JsonApi">
    <Related xmlns:d3p1="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api">
      <d3p1:Href>http://example-url-1.com/</d3p1:Href>
      <d3p1:Meta i:nil="true" />
    </Related>
    <Self xmlns:d3p1="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api">
      <d3p1:Href>http://example-url-1.com/</d3p1:Href>
      <d3p1:Meta i:nil="true" />
    </Self>
  </Links>
  <Meta xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.JsonApi">
    <Copyright>© 2025 The Access Group</Copyright>
  </Meta>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.Webhooks" xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api">
    <Id xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.JsonApi">12345</Id>
    <Attributes xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.JsonApi">
      <d2p1:Name>Sample string 2</d2p1:Name>
      <d2p1:EndPointUrl>Sample string 1</d2p1:EndPointUrl>
    </Attributes>
  </Data>
</WebhookEventTypeResponse>

Back